Introduction

Amazon Q makes the command line easier to use.

Installation

Installation of Amazon Q varies per platform.

Installing Amazon Q for use over SSH

  1. Ensure that you've installed Amazon Q on your local machine.
  2. Follow the SSH guide

Amazon Q on macOS

Installation

  1. Download Amazon Q for macOS
  2. Navigate to where you downloaded Amazon Q and double-click on it.
  3. You will be prompted to move the application into your Applications folder.
  4. (optional) Execute codesign -v /Applications/Amazon\ Q.app and ensure there is no output. This means the code signature is valid.
  5. Open Amazon Q from the Applications folder by double clicking the icon.
  6. (optional) Add Amazon Q to your Dock by right clicking the application icon and choosing Options/Keep in Dock

Complete onboarding steps

Most developers will log in using Builder ID as it is the simplest way to authenticate. Enterpise developers will likely authenticate using IAM Identity Center.

  1. Log in when prompted.
  2. Complete the onboarding steps in order to customize your install.
  3. Open a new terminal session to start using Autocomplete and the q CLI.

Support and Uninstall

If you're having issues with your installation, first run

q doctor

If that fails to resolve your issue, see our support guide. Otherwise run the following command to uninstall Amazon Q

q uninstall

Amazon Q on Linux

Installation

Direct Download

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"
unzip q.zip
q/install.sh

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"
unzip q.zip
q/install.sh

Getting Started

After installation, simply run:

q login

Most developers will log in using Builder ID as it is the simplest way to authenticate. Enterprise developers will likely authenticate using IAM Identity Center.

This will guide you through the authentication process and help you customize your installation. Once complete, open a new terminal session to start using Autocomplete and the q CLI.

Support and Uninstall

If you're having issues with your installation, first run

q doctor

If that fails to resolve your issue, see our support guide. Otherwise run the following command to uninstall Amazon Q

q uninstall

Over SSH

Support and feature requests

Support

If you have a security related issue or concern, please report it using the vulnerability reporting page or by emailing aws-security@amazon.com. Do not follow the guidance on this page.

The first thing to try before reaching out is to run q doctor.

q doctor will first attempt to autoresolve issues when possible and alert you when it can't. When successful, doctor will display the output below.

If doctor fails to resolve your issue, the next thing to try is to create an issue by running q issue.

q issue will prefill diagnostic info and direct you to our issue template to submit. These items are reviewed by the support and service teams weekly.

If for some reason q is not on your path you will need to create an issue manually.

If your issue is causing problems with your machine, run q uninstall.

q uninstall will uninstall Amazon Q entirely.

Feature requests

For feature requests, please create a discussion here. Discussions are voted on by the community and triaged quarterly.