amazon-q-developer-cli

Amazon Q Developer CLI (Amazon Q CLI) is a Rust-based command-line interface that lets you interact with the Amazon Q Developer tooling from the terminal. The project is now considered legacy and is superseded by Kiro CLI, but the repository provides a functional CLI that you can build and run locally. The chat_cli binary exposes the same core experience: you can issue commands to the Amazon Q Developer platform, view results, and perform typical CLI operations via subcommands. To get started, run the compiled binary from your local environment and explore the available subcommands and options documented in the CLI help output.

Prerequisites

• A macOS or Linux environment with a working Rust toolchain
• Rustup and the Rust toolchain installed

Step-by-step installation

1. Clone the repository

git clone https://github.com/aws/amazon-q-developer-cli.git

2. Install the Rust toolchain (if you haven't already)

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default stable
rustup toolchain install nightly

3. Build and run the chat CLI

cd amazon-q-developer-cli
cargo run --bin chat_cli

4. Optional: run tests or lint as needed

cargo test
cargo clippy

Notes

• The README mentions using nightly toolchains for some commands; you can switch back and forth with rustup if needed.
• The project has been superseded by Kiro CLI for new features; this locally built binary will provide legacy functionality where applicable.

Tips and considerations:

• The project is marked as no longer actively maintained; for new features or updates, consider using Kiro CLI.
• If you encounter build issues related to Rust toolchain versions, switch to the nightly or appropriate stable versions using rustup.
• The CLI relies on the local Rust toolchain and cargo; ensure you have network access to fetch dependencies during the first build.
• Since this is a legacy tool, verify compatibility with any AWS services you plan to use and be mindful of security advisories for the repository.