AWS amazonq documentation change
Summary
Complete restructuring of documentation with added sections for SSH integration, inline suggestions, supported tools list, and natural language translation feature. Removed settings customization content and added step-by-step usage instructions.
Security assessment
Changes focus on feature usage and documentation reorganization. No mention of vulnerabilities, security patches, or access controls. SSH integration instructions are operational rather than security-focused.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/command-line-autocomplete.md b/amazonq/latest/qdeveloper-ug/command-line-autocomplete.md index d10639584..5ca287c4b 100644 --- a//amazonq/latest/qdeveloper-ug/command-line-autocomplete.md +++ b//amazonq/latest/qdeveloper-ug/command-line-autocomplete.md @@ -5 +5 @@ -Popular settings +Using Amazon Q autocompleteUsing autocomplete over SSHInlineSupported toolsTranslating @@ -7 +7 @@ Popular settings -# Generating command line completions +# Using Amazon Q autocomplete on the command line @@ -9 +9 @@ Popular settings -You can use Amazon Q Developer to add IDE-style completions to hundreds of popular CLIs like `git`, `npm`, `docker`, and `aws`. When you start typing in the CLI, and Amazon Q suggests contextually relevant subcommands, options, and arguments. +Amazon Q for command line provides AI-powered autocompletion for hundreds of popular command line tools, including git, npm, docker, and aws. As you type commands, Amazon Q suggests relevant options, subcommands, and arguments based on your current context. @@ -11 +11 @@ You can use Amazon Q Developer to add IDE-style completions to hundreds of popul - +## Using Amazon Q autocomplete @@ -13 +13 @@ You can use Amazon Q Developer to add IDE-style completions to hundreds of popul -## Popular settings +Autocomplete is automatically enabled after you install Amazon Q for command line. @@ -15 +15 @@ You can use Amazon Q Developer to add IDE-style completions to hundreds of popul -The default settings provided by Amazon Q for command line may not fit your requirements and your existing workflow. You can customize your settings at any time by running `q` to open the settings dashboard. Here are a few popular settings: +**To use Amazon Q autocomplete** @@ -17 +17 @@ The default settings provided by Amazon Q for command line may not fit your requ - * Keybindings – Changing the tab keybinding to "Insert common prefix or navigate" can make command line completions appear like traditional shell completions while "Insert common prefix or insert" provides a feel like an IDE. + 1. [Install the Amazon Q command line.](./command-line-installing.html) @@ -19 +19 @@ The default settings provided by Amazon Q for command line may not fit your requ - * Theme – You can choose from a set of visual styling options to customize the appearance of the completion suggestions displayed in your terminal environment. + 2. Open your terminal or command prompt. @@ -21 +21 @@ The default settings provided by Amazon Q for command line may not fit your requ - * Instant execute after space – Enable the ability to execute a command after typing a space character to avoid Amazon Q blocking you. + 3. Start typing a command, and Amazon Q will display suggestions for completing your command. @@ -23 +23 @@ The default settings provided by Amazon Q for command line may not fit your requ - * First token completion – Enable the ability to get completions for CLIs themselves and not just the subcommands, options, and arguments. + 4. Press Tab to accept the suggestion, or continue typing to refine your command. @@ -28 +28,90 @@ The default settings provided by Amazon Q for command line may not fit your requ - +Autocomplete works with hundreds of command line tools, making it easier to remember command options and syntax. + +## Using autocomplete over SSH + +You can set up Amazon Q autocomplete to work over SSH connections from your local machine. + +**To use autocomplete over SSH** + + 1. Install Amazon Q for command line on your local machine. For more information, see [Installing Amazon Q for command line](./command-line-installing.html). + + 2. Set up SSH integration on both your local machine and remote server. For more information, see [Remote machines](./command-line-installing.html#command-line-remote-machines). + + 3. Connect to your remote server using SSH: + + ssh user@remote-server + + 4. Verify that autocomplete is working by typing a command and checking for suggestions. + + + + +## Amazon Q inline on the command line + +Amazon Q for command line provides AI-generated completions as you type in the command line. + + + +### Using Amazon Q inline + +Amazon Q inline suggestions appear as you type commands in your terminal. These suggestions are shown in a dimmed color and can be accepted by pressing the Tab key. + +To enable or disable inline suggestions, use the following command: + + + q config set inline.enabled true|false + +## Supported tools + +Amazon Q autocomplete supports a wide range of command line tools, including: + + * AWS CLI + + * Git + + * Docker + + * npm + + * kubectl + + * terraform + + * And many more standard Unix/Linux commands + + + + +To see a complete list of supported tools, use the following command: + + + q autocomplete list + +## Translating natural language to bash + +The `q translate` command lets you write a natural language instruction, such as "copy all files in my current directory to Amazon S3", and Amazon Q translates it to an instantly executable shell code snippet. + +**To translate natural language to bash** + + 1. Open your terminal or command prompt. + + 2. Use one of the following: + + * `q translate `prompt`` + + * `# `prompt`` + + + + +For example: + + + # list all ec2 instances in us-west-2 region + +Amazon Q will translate this to: + + + aws ec2 describe-instances --region us-west-2 + +You can press Enter to execute the command, or modify it before executing. @@ -36 +125 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Chat +Context Management @@ -38 +127 @@ Chat -Over SSH +Contributing