Add initial Q Developer customization

awscli/agentmode.py

@@ -0,0 +1,62 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+import argparse
+
+from awscli.argparser import CLIArgParser
+from awscli.customizations.q.chat import ChatCommand
+
+
+class AgentModeDriver(CLIArgParser):
+    """
+    Driver for the CLI to enable the Q plugin when the --agent-mode argument
+    is passed. This behaves more like a custom command, but is implemented
+    as a driver similar to autoprompt so we don't need to expose it as an
+    actual command via the command table.
+    """
+
+    _AGENT_MODE_ARG = '--agent-mode'
+
+    def __init__(self, driver):
+        super().__init__()
+        self._driver = driver
+        self._session = driver.session
+        self._parser = self._create_parser()
+
+    def _create_parser(self):
+        parser = argparse.ArgumentParser()
+        parser.add_argument(
+            '--region',
+            help='AWS region to use for agent inference.',
+            default=None,
+        )
+        parser.add_argument(
+            '--profile',
+            help='Use a specific profile from your credential file.',
+            default=None,
+        )
+        parser.add_argument(
+            self._AGENT_MODE_ARG,
+            action='store_true',
+            help='Enable agentic mode.',
+        )
+        return parser
+
+    def should_enter_agent_mode(self, args):
+        return self._AGENT_MODE_ARG in args
+
+    def enter_agent_mode(self, args):
+        parsed_args = self._parser.parse_args(args)
+
+        # TODO - handle the agent-mode-specific region and profile
+        return ChatCommand(self._session)('', parsed_args)

awscli/autocomplete/local/indexer.py

@@ -25,7 +25,7 @@ class ModelIndexer:
         'ddb': 'High level DynamoDB commands',
     }
 
-    _NON_SERVICE_COMMANDS = ['configure', 'history', 'cli-dev']
+    _NON_SERVICE_COMMANDS = ['configure', 'history', 'cli-dev', 'q']
 
     _CREATE_CMD_TABLE = """\
         CREATE TABLE IF NOT EXISTS command_table (

awscli/clidriver.py

@@ -33,6 +33,7 @@
 from botocore.history import get_global_history_recorder
 
 from awscli import __version__
+from awscli.agentmode import AgentModeDriver
 from awscli.alias import AliasCommandInjector, AliasLoader
 from awscli.argparser import (
     ArgTableArgParser,
@@ -231,7 +232,11 @@ def _do_main(self, args):
                 driver = create_clidriver(args)
                 rc = self._run_driver(driver, args, prompt_mode='partial')
         else:
-            rc = self._run_driver(driver, args, prompt_mode='off')
+            agent_mode_driver = AgentModeDriver(driver)
+            if agent_mode_driver.should_enter_agent_mode(args):
+                rc = agent_mode_driver.enter_agent_mode(args)
+            else:
+                rc = self._run_driver(driver, args, prompt_mode='off')
         return rc
 
 

awscli/customizations/q/__init__.py

@@ -0,0 +1,44 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+from awscli.customizations.commands import BasicCommand
+from awscli.customizations.q.chat import ChatCommand
+from awscli.customizations.q.uninstall import UninstallCommand
+from awscli.customizations.q.update import UpdateCommand
+from awscli.customizations.q.version import VersionCommand
+
+
+def register_q_commands(event_handlers):
+    event_handlers.register('building-command-table.main', inject_commands)
+
+
+def inject_commands(command_table, session, **kwargs):
+    command_table['q'] = QCommand(session)
+
+
+class QCommand(BasicCommand):
+    # 'TODO help prints "System Message: WARNING/2 (<string>:, line 7)"
+    # but not figuring out yet since naming may still change
+    NAME = 'q'
+    SYNOPSIS = 'q <command> [<args>]'
+    DESCRIPTION = (
+        'You can use Amazon Q Developer to translate natural language to '
+        'AWS CLI commands. Run ``aws q chat`` to launch the Q CLI. You can '
+        'update to the latest version of the Q plugin with ``aws q update``.'
+    )
+    SUBCOMMANDS = [
+        {'name': 'chat', 'command_class': ChatCommand},
+        {'name': 'version', 'command_class': VersionCommand},
+        {'name': 'update', 'command_class': UpdateCommand},
+        {'name': 'uninstall', 'command_class': UninstallCommand},
+    ]

awscli/customizations/q/chat.py

@@ -0,0 +1,39 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+import subprocess
+
+from botocore.utils import original_ld_library_path
+
+from awscli.customizations.commands import BasicCommand
+from awscli.customizations.q.utils import _get_executable_path_or_download
+
+
+class ChatCommand(BasicCommand):
+    NAME = 'chat'
+    DESCRIPTION = (
+        'Launch Amazon Q Developer, which can translate natural language '
+        'to AWS CLI commands.'
+    )
+
+    def __init__(self, session):
+        super().__init__(session)
+
+    def _run_main(self, parsed_args, parsed_globals):
+        path = _get_executable_path_or_download()
+        if not path:
+            raise RuntimeError('Amazon Q extension is not found.')
+
+        # TODO pass through credentials and region
+        with original_ld_library_path():
+            subprocess.check_call(path)

awscli/customizations/q/uninstall.py

@@ -0,0 +1,34 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+import shutil
+import sys
+from pathlib import Path
+
+from awscli.customizations.commands import BasicCommand
+from awscli.customizations.q.utils import Q_EXTENSION_DIR, Q_EXTENSION_PATH
+
+
+class UninstallCommand(BasicCommand):
+    NAME = 'uninstall'
+    DESCRIPTION = 'Uninstall the Q CLI extension.'
+
+    def __init__(self, session):
+        super().__init__(session)
+
+    def _run_main(self, parsed_args, parsed_globals):
+        if not Path.is_file(Q_EXTENSION_PATH):
+            sys.stdout.write('The Q CLI extension is not installed.\n')
+        else:
+            shutil.rmtree(Q_EXTENSION_DIR, ignore_errors=True)
+            sys.stdout.write(f'Uninstalled {Q_EXTENSION_DIR}\n')

awscli/customizations/q/update.py

@@ -0,0 +1,28 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+import sys
+
+from awscli.customizations.commands import BasicCommand
+
+
+class UpdateCommand(BasicCommand):
+    NAME = 'update'
+    DESCRIPTION = 'Update the Q CLI extension.'
+
+    def __init__(self, session):
+        super().__init__(session)
+
+    def _run_main(self, parsed_args, parsed_globals):
+        # TODO - implement this
+        pass

awscli/customizations/q/utils.py

@@ -0,0 +1,26 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+from pathlib import Path
+
+EXTENSIONS_DIR = Path.home() / '.aws' / 'cli' / 'extensions'
+Q_EXTENSION_DIR = EXTENSIONS_DIR / 'q'
+Q_EXTENSION_PATH = Q_EXTENSION_DIR / 'q'
+
+
+def _get_executable_path_or_download():
+    if Path.is_file(Q_EXTENSION_PATH):
+        return Q_EXTENSION_PATH
+
+    # TODO - implement download
+    return None

awscli/customizations/q/version.py

@@ -0,0 +1,40 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+import subprocess
+from pathlib import Path
+
+from botocore.utils import original_ld_library_path
+
+from awscli.customizations.commands import BasicCommand
+from awscli.customizations.q.utils import Q_EXTENSION_PATH
+
+
+class VersionCommand(BasicCommand):
+    NAME = 'version'
+    DESCRIPTION = 'Displays the version of the Q CLI extension.'
+
+    def __init__(self, session):
+        super().__init__(session)
+
+    def _run_main(self, parsed_args, parsed_globals):
+        # version doesn't install the Q extension if needed like
+        # chat does, so check Q_EXTENSION_PATH directly
+        if not Path.is_file(Q_EXTENSION_PATH):
+            raise RuntimeError(
+                'The Q CLI extension is not installed. '
+                'Run aws q chat or aws q upgrade to install it.'
+            )
+
+        with original_ld_library_path():
+            subprocess.check_call(f'{Q_EXTENSION_PATH} --version'.split(' '))

awscli/data/cli.json

@@ -85,6 +85,10 @@
         "no-cli-auto-prompt": {
             "action": "store_true",
             "help": "<p>Disable automatically prompt for CLI input parameters.</p>"
+        },
+        "agent-mode": {
+            "action": "store_true",
+            "help": "<p>Enter agent mode, which can translate natural language to AWS CLI commands.</p>"
         }
     }
 }

awscli/examples/global_options.rst

@@ -96,3 +96,7 @@
 
   Disable automatically prompt for CLI input parameters.
 
+``--agent-mode`` (boolean)
+
+  Enter agent mode, which can translate natural language to AWS CLI commands.
+

awscli/examples/global_synopsis.rst

@@ -16,3 +16,4 @@
 [--no-cli-pager]
 [--cli-auto-prompt]
 [--no-cli-auto-prompt]
+[--agent-mode]

awscli/handlers.py

@@ -98,6 +98,7 @@
 from awscli.customizations.opsworkscm import register_alias_opsworks_cm
 from awscli.customizations.paginate import register_pagination
 from awscli.customizations.putmetricdata import register_put_metric_data
+from awscli.customizations.q import register_q_commands
 from awscli.customizations.quicksight import (
     register_quicksight_asset_bundle_customizations,
 )
@@ -237,3 +238,4 @@ def awscli_initialize(event_handlers):
     register_kinesis_list_streams_pagination_backcompat(event_handlers)
     register_quicksight_asset_bundle_customizations(event_handlers)
     register_ec2_instance_connect_commands(event_handlers)
+    register_q_commands(event_handlers)

tests/unit/customizations/q/__init__.py

@@ -0,0 +1,12 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.