AWS amazonq documentation change
Summary
Restructured installation documentation, added sections for Linux AppImage, SSH autocomplete setup, verifying downloads, uninstalling, and debugging. Replaced detailed PGP verification steps with checksum verification.
Security assessment
The changes introduce a 'Verifying downloads' section using checksums, which documents a security-related verification process. However, there is no explicit mention of addressing a specific security vulnerability or incident. The removal of PGP verification steps does not directly indicate a security issue without additional context.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/command-line-installing.md b/amazonq/latest/qdeveloper-ug/command-line-installing.md index 0c55b8a3d..cc69e621a 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)ZIP setup for autocomplete supportUbuntu/Debian (Linux)AppImage (Linux)Alternative Linux builds (musl libc/compatibility build)Handling glibc version issues +macOSWindows Subsystem for Linux (WSL)Linux AppImageUbuntuSetting up SSH autocompleteRemote machinesVerifying downloadsUninstallingDebugging @@ -9 +9 @@ macOSWindows Subsystem for Linux (WSL)ZIP setup for autocomplete supportUbuntu/D -You can install Amazon Q for command line for macOS by initiating a file download for the Amazon Q application. For more information, see [Supported command line environments for autocomplete](./command-line-supported-envs.html). +You can install Amazon Q for command line for macOS by initiating a file download for the Amazon Q application. For more information, see [Supported command line environments](./command-line-supported-envs.html). @@ -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 ZIP setup for autocomplete support. +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. @@ -17 +17 @@ You can install Amazon Q for command line for macOS by downloading the applicati -After installing Amazon Q for command line for macOS, you can enable SSH integration to be able to use autocomplete for over 500 command line tools. For more information, see [Local macOS Integration](./command-line-autocomplete-ssh.html#command-line-autocomplete-ssh-setup-local-mac). +After installing Amazon Q for command line for macOS, you can enable SSH integration to be able to use autocomplete for over 500 command line tools. For more information, see [](./command-line-autocomplete.html#command-line-autocomplete-ssh-setup-local-mac). @@ -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 your download](./command-line-verify.html). + 2. (Optional) Verify the downloaded file for Amazon Q for command line on macOS. For more information, see Verifying downloads. @@ -61 +61 @@ 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 ZIP setup for autocomplete support. + 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. @@ -78 +78 @@ When using Amazon Q CLI in WSL, it has access to files within the WSL filesystem -### Example +## Linux AppImage @@ -80 +80 @@ When using Amazon Q CLI in WSL, it has access to files within the WSL filesystem -The following procedure steps show how WSL can be installed: +You can install Amazon Q for command line for Linux using the AppImage format, which is a portable format that works on most Linux distributions without requiring installation. @@ -82,60 +82 @@ The following procedure steps show how WSL can be installed: - 1. In a working command prompt, install WSL on your windows machine using the following command: - - wsl —install - - 2. Run a specific distribution. For Ubuntu, use the following command: - - wsl -d Ubuntu - - 3. Create a default account with a password for your newly installed Linux distribution. For more information, see [Set up and best practices](https://learn.microsoft.com/en-us/windows/wsl/install). - - 4. Install the unzip utility for Ubuntu using the following the command: - - sudo apt install unzip - - 5. Download the installation file using the following command: - - curl --proto '=https' --tlsv1.2 -sSf https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/q-x86_64-linux-musl.zip -o q.zip - - 6. Unzip the installation file using the following command: - - unzip q.zip - - 7. Execute the install using the following commands: - - chmod +x q/install.sh - - q/install.sh - - 8. Address the following: - - 1. `Do you want q to modify your shell config (you will have to manually do this otherwise)?` - - 2. `Select login method` - - 3. `Enter Start URL` - - 4. `Enter Region` - - 5. Manually open browser URL. - - 6. Complete the login. - - 9. Restart the Z Shell to refresh session information and apply changes. - - - - -## ZIP setup for autocomplete support - -The SSH setup for remote Linux integration requires installing the file, verifying the file, and installing the program. - -### Install and update requirements - - * You must be able to extract or "unzip" the downloaded package. If your operating system doesn't have the built-in unzip command, use an equivalent. - - * Amazon Q for command line uses glibc 2.34 or newer. It's included by default in most major distributions of Linux released since 2021. For older distributions, a version is statically linked with the musl library (`-musl.zip`). - - * Amazon Q for command line is supported on 64-bit x86_64 and ARM aarch64 versions of recent distributions of Fedora, Ubuntu, and Amazon Linux 2023. - - * AWS doesn't maintain third-party repositories, so it's not a guarantee that they contain the latest version of the Amazon Q command line. +**To install Amazon Q for command line for Linux using AppImage** @@ -142,0 +84 @@ The SSH setup for remote Linux integration requires installing the file, verifyi + 1. [Download Amazon Q for command line for Linux AppImage.](https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/amazon-q.appimage) @@ -143,0 +86 @@ The SSH setup for remote Linux integration requires installing the file, verifyi + 2. Make the AppImage executable: @@ -144,0 +88 @@ The SSH setup for remote Linux integration requires installing the file, verifyi + chmod +x amazon-q.appimage @@ -146 +90 @@ The SSH setup for remote Linux integration requires installing the file, verifyi -**To download the zip file and verify** + 3. Run the AppImage: @@ -148 +92 @@ The SSH setup for remote Linux integration requires installing the file, verifyi - 1. Download the installation file in one of the following ways: + ./amazon-q.appimage @@ -150 +94 @@ The SSH setup for remote Linux integration requires installing the file, verifyi -Linux x86-64 + 4. Authenticate with [ Builder ID](https://docs.aws.amazon.com/general/latest/gr/aws_builder_id.html), or with [IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) using the start URL given to you by your account administrator. @@ -152 +95,0 @@ Linux x86-64 - curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/q-x86_64-linux.zip" -o "q.zip" @@ -154 +96,0 @@ Linux x86-64 -Linux ARM (aarch64) @@ -156 +97,0 @@ Linux ARM (aarch64) - curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/q-aarch64-linux.zip" -o "q.zip" @@ -158 +99 @@ Linux ARM (aarch64) - 2. (Optional) Verifying the integrity of your downloaded zip file. +## Ubuntu @@ -160 +101 @@ Linux ARM (aarch64) -If you chose to manually download the Amazon Q command line installer package .zip in the above steps, you can use the following steps to verify the signatures by using the GnuPG tool. +You can install Amazon Q for command line for Ubuntu using the .deb package. @@ -162 +103 @@ If you chose to manually download the Amazon Q command line installer package .z -The Amazon Q command line installer package .zip files are cryptographically signed using PGP signatures. If there's any damage or alteration of the files, this verification fails and you should not proceed with installation. +**To install Amazon Q for command line for Ubuntu** @@ -164 +105 @@ The Amazon Q command line installer package .zip files are cryptographically sig - 1. Download and install the gpg command using your package manager. For more information about GnuPG, see the [GnuPG documentation](https://gnupg.org/documentation/index.html). + 1. [Download Amazon Q for command line for Ubuntu.](https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/amazon-q.deb) @@ -166 +107 @@ The Amazon Q command line installer package .zip files are cryptographically sig - 2. To create the public key file, create a text file, and then paste in the following text. + 2. Install the package: @@ -168 +109,2 @@ The Amazon Q command line installer package .zip files are cryptographically sig - -----BEGIN PGP PUBLIC KEY BLOCK----- + sudo dpkg -i amazon-q.deb + sudo apt-get install -f @@ -170,11 +112 @@ The Amazon Q command line installer package .zip files are cryptographically sig - mDMEZig60RYJKwYBBAHaRw8BAQdAy/+G05U5/EOA72WlcD4WkYn5SInri8pc4Z6D - BKNNGOm0JEFtYXpvbiBRIENMSSBUZWFtIDxxLWNsaUBhbWF6b24uY29tPoiZBBMW - CgBBFiEEmvYEF+gnQskUPgPsUNx6jcJMVmcFAmYoOtECGwMFCQPCZwAFCwkIBwIC - IgIGFQoJCAsCBBYCAwECHgcCF4AACgkQUNx6jcJMVmef5QD/QWWEGG/cOnbDnp68 - SJXuFkwiNwlH2rPw9ZRIQMnfAS0A/0V6ZsGB4kOylBfc7CNfzRFGtovdBBgHqA6P - zQ/PNscGuDgEZig60RIKKwYBBAGXVQEFAQEHQC4qleONMBCq3+wJwbZSr0vbuRba - D1xr4wUPn4Avn4AnAwEIB4h+BBgWCgAmFiEEmvYEF+gnQskUPgPsUNx6jcJMVmcF - AmYoOtECGwwFCQPCZwAACgkQUNx6jcJMVmchMgEA6l3RveCM0YHAGQaSFMkguoAo - vK6FgOkDawgP0NPIP2oA/jIAO4gsAntuQgMOsPunEdDeji2t+AhV02+DQIsXZpoB - =f8yY - -----END PGP PUBLIC KEY BLOCK----- + 3. Launch Amazon Q for command line: @@ -182 +114 @@ The Amazon Q command line installer package .zip files are cryptographically sig - 3. Import the Amazon Q command line public key with the following command, substituting `public-key-file-name` with the file name of the public key you created. + amazon-q @@ -184,7 +116 @@ The Amazon Q command line installer package .zip files are cryptographically sig - gpg --import public-key-file-name - gpg: directory '/home/username/.gnupg' created - gpg: keybox '/home/username/.gnupg/pubring.kbx' created - gpg: /home/username/.gnupg/trustdb.gpg: trustdb created - gpg: key 50DC7A8DC24C5667: public key "Amazon Q command line Team <q-command [email protected]>" imported - gpg: Total number processed: 1 - gpg: imported: 1 + 4. Authenticate with [ Builder ID](https://docs.aws.amazon.com/general/latest/gr/aws_builder_id.html), or with [IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) using the start URL given to you by your account administrator. @@ -192 +117,0 @@ The Amazon Q command line installer package .zip files are cryptographically sig - 4. Download the Amazon Q command line signature file for the package you downloaded. It has the same path and name as the .zip file it corresponds to, but has the extension .sig. In the following examples, we save it to the current directory as a file named q.zip.sig. @@ -194 +118,0 @@ The Amazon Q command line installer package .zip files are cryptographically sig -Linux x86-64 @@ -196 +119,0 @@ Linux x86-64 -For the latest version of the Amazon Q command line, use the following command: @@ -198 +121 @@ For the latest version of the Amazon Q command line, use the following command: - curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/q-x86_64-linux.zip.sig" -o "q.zip.sig" +## Setting up SSH autocomplete @@ -200 +123 @@ For the latest version of the Amazon Q command line, use the following command: -For a specific version of the Amazon Q command line, replace the latest with the version number. For this example the path for version 1.1.0 would be `/1.1.0/q-linux-x86_64.zip.sig`, resulting in the following command: +You can set up SSH autocomplete to use Amazon Q for command line over SSH connections. @@ -202 +125 @@ For a specific version of the Amazon Q command line, replace the latest with the - curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/1.1.0/q-x86_64-linux.zip.sig" -o "q.zip.sig" +**To set up SSH autocomplete** @@ -204 +127 @@ For a specific version of the Amazon Q command line, replace the latest with the -Linux ARM (aarch64) + 1. Install Amazon Q for command line on your local machine. @@ -206 +129 @@ Linux ARM (aarch64) -For the latest version of the Amazon Q command line, use the following command: + 2. Enable SSH integration: @@ -208 +131 @@ For the latest version of the Amazon Q command line, use the following command: - curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/latest/q-aarch64-linux.zip.sig" -o "q.zip.sig" + q integrations install ssh @@ -210 +133 @@ For the latest version of the Amazon Q command line, use the following command: -For a specific version of the Amazon Q command line, replace the latest with the version number. For this example the path for version 1.1.0 would be `/1.1.0/q-linux-aarch64.zip.sig`, resulting in the following command: + 3. On the remote machine, install the minimal version of Amazon Q for command line: @@ -212 +135,4 @@ For a specific version of the Amazon Q command line, replace the latest with the - curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/1.1.0/q-aarch64-linux.zip.sig" -o "q.zip.sig" + curl -fsSL https://desktop-release.codewhisperer.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/ @@ -214 +140 @@ For a specific version of the Amazon Q command line, replace the latest with the -For a specific version of the Amazon Q command line, replace the latest with the version number. For this example the path for version 1.1.0 would be `/1.1.0/q-linux-aarch64.zip.sig`, resulting in the following command: + 4. Configure the SSH server on the remote machine by editing the sshd_config file: @@ -216 +142 @@ For a specific version of the Amazon Q command line, replace the latest with the - curl --proto '=https' --tlsv1.2 -sSf "https://desktop-release.codewhisperer.us-east-1.amazonaws.com/1.1.0/q-aarch64-linux.zip.sig" -o "q.zip.sig" + sudo nano /etc/ssh/sshd_config @@ -218 +144 @@ For a specific version of the Amazon Q command line, replace the latest with the - 5. Verify the signature, passing both the downloaded .sig and .zip file names as parameters to the gpg command. +Add the following lines: @@ -220 +146,2 @@ For a specific version of the Amazon Q command line, replace the latest with the - gpg --verify q.zip.sig q.zip + AcceptEnv Q_SET_PARENT