aws/amazon-q-developer-cli

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

macOS:
- DMG: Download now
- HomeBrew: brew install --cask amazon-q
Linux:

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.