mcpField
A
Amazon Q Developer CLI

Amazon Q Developer CLI

OfficialAgent-ready
docs.aws.amazon.comAI & Agents2.0kqUpdated 27w ago
RepositoryVisit website

About Amazon Q Developer CLI

AWS's official terminal coding assistant providing interactive development support and shell command completion. Understands AWS services and can assist with coding tasks through natural language.

Key features

  1. 01Chat interactively with AI assistant for coding tasks
  2. 02Get shell command suggestions and auto-completion
  3. 03Receive AWS-specific development guidance
  4. 04Diagnose environment and configuration issues

Use cases

  1. 01Accelerate coding and deployment in AWS environments
  2. 02Learn and use AWS services more efficiently
  3. 03Improve shell command accuracy with AI assistance

Install

Pick your OS or package manager and run the command in a terminal.

$
brew install --cask amazon-q

Once installed, runq --versionto confirm it works.

Example commands

Common commands in the order you’d use them.

01
q login
02
q chat
03
q doctor

Details

From the project README

Amazon Q CLI

Important

This open source project is no longer being actively maintained and will only receive critical security fixes. Amazon Q Developer CLI is now available as Kiro CLI, a closed-source product. For the latest features and updates, please use Kiro CLI. For issues with Kiro CLI, please report it here instead.

Installation

Contributing

Thank you so much for considering to contribute to Amazon Q.

Before getting started, see our contributing docs.

Prerequisites
  • MacOS
    • Xcode 13 or later
    • Brew
1. Clone repo
git clone https://github.com/aws/amazon-q-developer-cli.git
2. Install the Rust toolchain using Rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default stable
rustup toolchain install nightly
cargo install typos-cli
3. Develop locally
  • To compile and run: cargo run --bin chat_cli.
  • To run tests: cargo test.
  • To run lints: cargo clippy.
  • To format rust files: cargo +nightly fmt.
  • To run subcommands: cargo run --bin chat_cli -- {subcommand}.
    • Login would then be: cargo run --bin chat_cli -- login

Project Layout

  • chat_cli - the q CLI, allows users to interface with Amazon Q Developer from the command line
  • scripts/ - Contains ops and build related scripts
  • crates/ - Contains all rust crates
  • docs/ - Contains technical documentation

Security

For security related concerns, see here.

Licensing

This repo is dual licensed under MIT and Apache 2.0 licenses.

Those licenses can be found here and here.

“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.

Comments

Markdown supported