AWS amazonq documentation change
Summary
Removed sections about SSH autocomplete setup, remote machines, and download verification. Added warnings about GUI requirements for Linux installations. Updated links to point to new pages for SSH autocomplete and download verification. Adjusted installation commands for Ubuntu.
Security assessment
The changes primarily restructure documentation, remove redundant sections, and add installation warnings. While the removed 'Verifying downloads' section previously covered security best practices, the diff retains a link to a new page for verification steps, indicating content was moved rather than removed. No concrete evidence of addressing vulnerabilities or security incidents exists in the diff.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/command-line-installing.md b/amazonq/latest/qdeveloper-ug/command-line-installing.md index 97f377004..cc4adb9c6 100644 --- a//amazonq/latest/qdeveloper-ug/command-line-installing.md +++ b//amazonq/latest/qdeveloper-ug/command-line-installing.md @@ -5 +5 @@ -macOSWindows Subsystem for Linux (WSL)Linux AppImageUbuntuSetting up SSH autocompleteRemote machinesVerifying downloadsUninstallingDebugging +macOSWindows Subsystem for Linux (WSL)Linux AppImageUbuntuUninstallingDebugging @@ -11 +11 @@ You can install Amazon Q for command line for macOS by initiating a file downloa -There are two modalities to consider when installing Amazon Q for command line. Minimal installation only distributes the binaries needed on Linux for Amazon Q chat and for the autocomplete feature to function over SSH (`q` and `qterm`). Full distribution contains the desktop application and requires the autocomplete feature to be used. If you want to only use the Amazon Q chat, consider that the minimal distribution also ships and installs `qterm` to your shell. You can use `qterm` for ZShell to support inline completions and a full version isn't required. For more information, see Setting up SSH autocomplete. +There are two modalities to consider when installing Amazon Q for command line. Minimal installation only distributes the binaries needed on Linux for Amazon Q chat and for the autocomplete feature to function over SSH (`q` and `qterm`). Full distribution contains the desktop application and requires the autocomplete feature to be used. If you want to only use the Amazon Q chat, consider that the minimal distribution also ships and installs `qterm` to your shell. You can use `qterm` for zsh to support inline completions and a full version isn't required. For more information, see [Installing with a zip file](./command-line-installing-ssh-setup-autocomplete.html). @@ -23 +23 @@ After installing Amazon Q for command line for macOS, you can enable SSH integra - 2. (Optional) Verify the downloaded file for Amazon Q for command line on macOS. For more information, see Verifying downloads. + 2. (Optional) Verify the downloaded file for Amazon Q for command line on macOS. For more information, see [](./command-line-verify-download.html). @@ -63 +63 @@ While Amazon Q CLI doesn't have a native Windows version, you can use it on Wind - 4. Download the appropriate zip file installer version of the Linux package for your WSL distribution. To learn about the different zip files, see Setting up SSH autocomplete. + 4. Download the appropriate zip file installer version of the Linux package for your WSL distribution. To learn about the different zip files, see [Installing with a zip file](./command-line-installing-ssh-setup-autocomplete.html). @@ -78 +78 @@ This is a minimal Linux installation. Desktop Linux users have GUI components av -When using Amazon Q CLI in WSL, it has access to files within the WSL filesystem. To work with files on your Windows drives, access them through the `/mnt/c/`path for C: drive`` within WSL. +When using Amazon Q CLI in WSL, it has access to files within the WSL filesystem. To work with files on your Windows drives, access them through the `/mnt/`drive letter`` within WSL. @@ -81,0 +82,4 @@ When using Amazon Q CLI in WSL, it has access to files within the WSL filesystem +###### Warning + +This installation method requires a GUI. If you are installing on Linux without a GUI, see [Installing with a zip file](./command-line-installing-ssh-setup-autocomplete.html). + @@ -102,0 +107,4 @@ You can install Amazon Q for command line for Linux using the AppImage format, w +###### Warning + +This installation method requires a GUI. If you are installing on Linux without a GUI, see [Installing with a zip file](./command-line-installing-ssh-setup-autocomplete.html). + @@ -108,0 +117,2 @@ You can install Amazon Q for command line for Ubuntu using the .deb package. + wget https://desktop-release.q.us-east-1.amazonaws.com/latest/amazon-q.deb + @@ -111 +120,0 @@ You can install Amazon Q for command line for Ubuntu using the .deb package. - sudo dpkg -i amazon-q.deb @@ -112,0 +122,2 @@ You can install Amazon Q for command line for Ubuntu using the .deb package. + sudo dpkg -i amazon-q.deb + @@ -123,105 +133,0 @@ You can install Amazon Q for command line for Ubuntu using the .deb package. -## Setting up SSH autocomplete - -You can set up SSH autocomplete to use Amazon Q for command line over SSH connections. - -**To set up SSH autocomplete** - - 1. Install Amazon Q for command line on your local machine. - - 2. Enable SSH integration: - - q integrations install ssh - - 3. On the remote machine, install the minimal version of Amazon Q for command line: - - curl -fsSL https://desktop-release.q.us-east-1.amazonaws.com/latest/q-x86_64-linux.zip -o q-x86_64-linux.zip - unzip q-x86_64-linux.zip - sudo mv q/bin/q /usr/local/bin/ - sudo mv q/bin/qterm /usr/local/bin/ - - 4. Configure the SSH server on the remote machine by editing the sshd_config file: - - sudo nano /etc/ssh/sshd_config - -Add the following lines: - - AcceptEnv Q_SET_PARENT - AllowStreamLocalForwarding yes - - 5. Restart the SSH service: - - sudo systemctl restart sshd - - 6. Reconnect to the remote machine and verify the installation: - - q doctor - - - - -## Remote machines - -When you install Amazon Q for the command line locally, it adds autocomplete for over 500 command line tools to your existing terminal in your local environment. By enabling SSH integration, you can make command line autocomplete accessible on remote machines as well. - -### Local macOS Integration - -**To enable SSH integration** - - 1. Open your terminal or command prompt. - - 2. Enable the local SSH integrations using the following command: - - q integrations install ssh - - - - -### Remote Linux integration - -Before you can configuration the SSH integration for your remote Linux machine, you must complete the installation process. For more information, see Setting up SSH autocomplete. - -**To configure the SSH integration** - - 1. Install SSH config integrations. To do this you must edit your `sshd_config` to add the `AcceptEnv` and `AllowStreamLocalForwarding` setting. To edit the `sshd_config`, use the following: - - sudo -e /etc/ssh/sshd_config - -When you're editing the `sshd_config`, add the following to the end of the config file: - - AcceptEnv Q_SET_PARENT - AllowStreamLocalForwarding yes - -You need to also restart the sshd process after installing the program. If you're using systemd, you can use the following: - - sudo systemctl restart sshd - - 2. To finish setting up the integrations, you need to disconnect from the SSH instance and reconnect. Once you reconnect, you can login to Amazon Q by running: - - q login - -To check for any other installation issues, use the following: - - q doctor - - - - -## Verifying downloads - -You can verify the integrity of your Amazon Q for command line downloads using checksums. - -**To verify Amazon Q for command line downloads** - - 1. Download the checksum file corresponding to your download: - - curl -O https://desktop-release.q.us-east-1.amazonaws.com/latest/checksums.txt - - 2. Verify the checksum: - - sha256sum -c checksums.txt - - 3. If the verification is successful, you'll see "OK" next to your downloaded file. - - - - @@ -317 +223 @@ Supported environments -Using chat +With a zip file