- 🔮 Auto Completion: IDE-style completions to hundreds of popular CLIs like
git,npm,docker, andaws. - 💬 Natural Language Chat: Interact with your terminal using natural language to ask questions, debug issues, or explore the codebase.
- 🧠 Contextual Awareness: Integrates context from your local development environment, so answers are tailored to your specific code and setup.
- 🤖 Agentic Execution: Let Amazon Q take action: generate code, edit files, automate Git workflows, resolve merge conflicts, and more — with your permission.
- macOS:
- DMG: Download now
- Homebrew:
brew install amazon-q
- Linux:
- Windows:
- Follow the discussions for Windows
- Or use it on Windows with WSL
- Remote machines
- MacOS
- Xcode 13 or later
- Brew
git clone https://github.com/aws/amazon-q-for-command-line.gitHassle-free setup:
npm run setupOr if you'd like to DIY:
Manual Setup
For Debian/Ubuntu:
sudo apt update
sudo apt install build-essential pkg-config jq dpkg curl wget cmake clang libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libdbus-1-dev libwebkit2gtk-4.1-dev libjavascriptcoregtk-4.1-dev valac libibus-1.0-dev libglib2.0-dev sqlite3 libxdo-dev protobuf-compiler2. Install Rust toolchain using Rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default stableFor pre-commit hooks, the following commands are required:
rustup toolchain install nightly
cargo install typos-cliFor MacOS development make sure the right targets are installed:
rustup target add x86_64-apple-darwin
rustup target add aarch64-apple-darwin3. Setup Python and Node using mise
Add mise integrations to your shell:
For zsh:
echo 'eval "$(mise activate zsh)"' >> "${ZDOTDIR-$HOME}/.zshrc"For bash:
echo 'eval "$(mise activate bash)"' >> ~/.bashrcFor fish:
echo 'mise activate fish | source' >> ~/.config/fish/config.fishInstall the Python and Node toolchains using:
mise trust
mise installRun pnpm in root directory to add pre-commit hooks:
pnpm install --ignore-scriptsTo compile and view changes made to q chat:
cargo run --bin q_cli -- chatIf you are working on other q commands, just replace
chatwith the command name
To run tests for the Q CLI crate:
cargo test -p q_cliTo format Rust files:
cargo +nightly fmtTo run clippy:
cargo clippy --locked --workspace --color always -- -D warningsUse Q CLI to help you onboard Q CLI!
Start a q chat session:
q chatOnce inside q chat, you can supply project context by adding the codebase-summary.md file:
/context add codebase-summary.mdThis enables Q to answer onboarding questions like:
-
“What does this crate do?”
-
“Where is X implemented?”
-
“How do these components interact?”
Great for speeding up your ramp-up and navigating the repo more effectively.
Several projects live here:
autocomplete- The autocomplete react appdashboard- The dashboard react appfigterm- figterm, our headless terminal/pseudoterminal that intercepts the user’s terminal edit buffer.q_cli- theqCLI, allows users to interface with Amazon Q Developer from the command linefig_desktop- the Rust desktop app, usestao/wryfor windowing/webviewsfig_input_method- The input method used to get cursor position on macOSvscode- Contains the VSCode plugin needed for the Amazon Q Developer for command line to work in VSCodejetbrains- Contains the VSCode plugin needed for the Amazon Q Developer for command line to work in Jetbrains IDEs
Other folder to be aware of
build-scripts/- Contains all python scripts to build, sign, and test the project on macOS and Linuxcrates/- Contains all internal rust cratespackages/- Contains all internal npm packagesproto/- protocol buffer message specification for inter-process communicationtests/- Contain integration tests for the projects
Below is a high level architecture of how the different components of the app and their IPC:
See CONTRIBUTING for more information.
This repo is dual licensed under MIT and Apache 2.0 licenses.
“Amazon Web Services” and all related marks, including logos, graphic designs, and service names, are trademarks or trade dress of AWS in the U.S. and other countries. AWS’s trademarks and trade dress may not be used in connection with any product or service that is not AWS’s, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits AWS.