Installing Amazon Q for command line - Amazon Q Developer
macOSAppImage (Linux)Ubuntu/Debian (Linux)

Installing Amazon Q for command line

You can install the Amazon Q command line for macOS by initiating a file download for the Amazon Q application. For more information, see Supported command line environments.

macOS

To install Amazon Q for command line for macOS, complete the following steps:

  1. Download Amazon Q for command line for macOS.

  2. (Optional) Verify the downloaded file for Amazon Q command line for macOS. For more information, see Verifying your download.

  3. Authenticate with Builder ID, or with IAM Identity Center using the start URL given to you by your account administrator.

  4. Follow the instructions to install the shell integrations, and to grant macOS accessiblity permissions.

AppImage (Linux)

Amazon Q command line is available as an AppImage, a single file with all dependencies included. It executes on a wide variety of Linux environments. You can set the file executable and you can begin using it.

To install Amazon Q for command line for Linux with AppImage, complete the following steps:

  1. Download Amazon Q for command line for AppImage. Install the latest version using the following command:

    curl --proto '=https' --tlsv1.2 -sSf https://desktop-release.q.us-east-1.amazonaws.com/latest/amazon-q.appimage -o amazon-q.appimage

    For a specific version of the Amazon Q command line, you can replace ... /latest/ ... in the URL with the version number.

    Note

    Amazon Q command line follows semantic versioning.

  2. (Optional) Verify the downloaded Amazon Q command line for AppImage. For more information, see Verifying your download.

  3. Make the downloaded AppImage executable using the following command:

    chmod +x amazon-q.appimage

  4. (Optional) Move the downloaded AppImage to a location on your PATH.

  5. Execute the AppImage and follow the onboarding steps.

    The AppImage bundles an XDG Desktop Entry file that can be installed and managed locally for you if you prefer. If your system supports the XDG Autostart specification, this will enable autostart capabilities, ensuring that the application is run on startup.

    Note

    Your system must have FUSE version 2 installed to run AppImages. For Ubuntu 22 and above, you can install FUSE 2 by using the following command:

    sudo apt install libfuse2
    Note

    If the desktop application doesn't open, try running amazon-q.appimage directly in your terminal to view any output error logs. You can open a support issue in the Amazon Q for command line discussions GitHub repository.

  6. Authenticate with Builder ID, or with IAM Identity Center using the start URL provided by your account administrator.

  7. In a new terminal, use the following command:

    q doctor

    Follow any remediation instructions until you see the output: "✓ Everything looks good!"

Ubuntu/Debian (Linux)

The Amazon Q command line is available as a prebuilt deb that you can install manually. The deb is compatible with a variety of Debian style systems. If you encounter issues with Ubuntu, consider AppImage, which should work on most Linux environments.

To install Amazon Q for command line for Linux with Ubuntu/Debian, complete the following steps:

  1. Download the Amazon Q for command line deb package using the following command:

    curl --proto '=https' --tlsv1.2 -sSf https://desktop-release.q.us-east-1.amazonaws.com/latest/amazon-q.deb -o amazon-q.deb

    For a specific version of the Amazon Q command line, you can replace ... /latest/ ... in the URL with the version number.

    Note

    Amazon Q command line follows semantic versioning.

  2. (Optional) Verify the downloaded Amazon Q command line for Ubuntu/Debian. For more information, see Verifying your download.

  3. Install the Amazon Q command line using the following apt command:

    sudo apt install -y ./amazon-q.deb

    The apt command installs the binaries q, qterm, and q-desktop under /usr/local/bin.

  4. Open the desktop application using the following command:

    q
    Note

    If the desktop application doesn't open, run q-desktop directly in your terminal to view any output error logs. You can open a support issue by running q issue.

    The deb packages also includes a desktop entry that is installed under /usr/share/applications/amazon-q.desktop. If your environment supports the XDG Desktop Entry specifications, you can open the desktop application by searching for Amazon Q.

  5. Follow the onboarding steps.

  6. Authenticate with Builder ID, or with IAM Identity Center using the start URL provided by your account administrator.

  7. In a new terminal, use the following command:

    q doctor

    Follow any remediation instructions until see the output: "✓ Everything looks good!"