aws/amazon-q-developer-cliPublic

generated fromamazon-archives/__template_Custom

NotificationsYou must be signed in to change notification settings
Fork349
Star1.8k

✨ Agentic chat experience in your terminal. Build applications using natural language.

docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html

License

Apache-2.0, MIT licenses found

Licenses found

1.8k stars 349 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,112 Commits
.cargo		.cargo
.github		.github
.husky		.husky
build-config		build-config
crates		crates
docs		docs
schemas		schemas
scripts		scripts
terminal-bench-test		terminal-bench-test
.gitattributes		.gitattributes
.gitignore		.gitignore
.lintstagedrc.mjs		.lintstagedrc.mjs
.mise.toml		.mise.toml
.rustfmt.toml		.rustfmt.toml
.typos.toml		.typos.toml
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
Cross.toml		Cross.toml
LICENSE.APACHE		LICENSE.APACHE
LICENSE.MIT		LICENSE.MIT
README.md		README.md
SECURITY.md		SECURITY.md
book.toml		book.toml
deny.toml		deny.toml
knowledge_beta_improvements_agents		knowledge_beta_improvements_agents
rust-toolchain.toml		rust-toolchain.toml
typos.toml		typos.toml

Repository files navigation

Amazon Q CLI

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 ourcontributing 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 usingRustup:

curl --proto'=https' --tlsv1.2 -sSf https://sh.rustup.rs| shrustup default stablerustup toolchain install nightlycargo 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 - theq CLI, allows users to interface with Amazon Q Developer fromthe command line
scripts/ - Contains ops and build related scripts
crates/ - Contains all rust crates
docs/ - Contains technical documentation

Security

For security related concerns, seehere.

Licensing

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

Those licenses can be foundhere andhere.

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