{"id":24319348,"url":"https://github.com/aws/amazon-q-developer-cli","last_synced_at":"2025-05-14T22:10:29.592Z","repository":{"id":264082701,"uuid":"861937484","full_name":"aws/amazon-q-developer-cli","owner":"aws","description":"✨ Agentic AI experience in your terminal for building applications using natural language","archived":false,"fork":false,"pushed_at":"2025-05-12T00:55:58.000Z","size":19341,"stargazers_count":576,"open_issues_count":348,"forks_count":96,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-05-12T01:27:30.424Z","etag":null,"topics":["agent","ai","amazon-q","amazon-web-services","autocomplete","cli","linux","llm","macos","mcp","open-source","productivity","rust","shell","terminal","typescript"],"latest_commit_sha":null,"homepage":"https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aws.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.APACHE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":"docs/support/doctor.png","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-23T18:41:22.000Z","updated_at":"2025-05-12T00:07:40.000Z","dependencies_parsed_at":"2024-12-06T20:36:32.366Z","dependency_job_id":"a8a2a4e2-2d90-49ae-98dc-7aef51dba699","html_url":"https://github.com/aws/amazon-q-developer-cli","commit_stats":null,"previous_names":["aws/amazon-q-developer-cli"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Famazon-q-developer-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Famazon-q-developer-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Famazon-q-developer-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws%2Famazon-q-developer-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aws","download_url":"https://codeload.github.com/aws/amazon-q-developer-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253660452,"owners_count":21943794,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","ai","amazon-q","amazon-web-services","autocomplete","cli","linux","llm","macos","mcp","open-source","productivity","rust","shell","terminal","typescript"],"created_at":"2025-01-17T15:09:53.335Z","updated_at":"2025-05-14T22:10:24.577Z","avatar_url":"https://github.com/aws.png","language":"Rust","readme":"\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html\"\u003e\n    \u003cpicture\u003e\n      \u003cimg src=\"./.github/media/amazon-q-logo.avif\" alt=\"Amazon Q\"\n        width=\"200px\"\n      \u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003e\n  Amazon Q CLI brings IDE-style autocomplete and agentic capabilities to your terminal.\n\u003c/h4\u003e\n\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/aws/amazon-q-developer-cli/graphs/commit-activity\"\u003e\u003cimg alt=\"GitHub commit activity\" src=\"https://img.shields.io/github/commit-activity/m/aws/amazon-q-developer-cli\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/aws/amazon-q-developer-cli/issues\"\u003e\u003cimg alt=\"GitHub open issues\" src=\"https://img.shields.io/github/issues/aws/amazon-q-developer-cli\"/\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\n\u003cdiv align=\"center\"\u003e\n\n[![Rust Test](https://github.com/aws/amazon-q-developer-cli/actions/workflows/rust.yml/badge.svg)](https://github.com/aws/amazon-q-developer-cli/actions/workflows/rust.yml)\n[![Typos Test](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typos.yml/badge.svg)](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typos.yml)\n[![Typescript Test](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typescript.yml/badge.svg)](https://github.com/aws/amazon-q-developer-cli/actions/workflows/typescript.yml)\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html\"\u003e\n    \u003cpicture\u003e\n      \u003cimg src=\"./.github/media/amazon-q-cli-features.jpeg\" alt=\"Amazon Q CLI Features\"\n      \u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## 😍 Features\n-   🔮 [**Auto Completion**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete.html): IDE-style completions to hundreds of popular CLIs like `git`, `npm`, `docker`, and `aws`.\n-   💬 [**Natural Language Chat**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-chat.html): Interact with your terminal using natural language to ask questions, debug issues, or explore the codebase.\n-   🧠 [**Contextual Awareness**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-chat.html#command-line-chat-context-integration): Integrates context from your local development environment, so answers are tailored to your specific code and setup.\n-   🤖 [**Agentic Execution**](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete.html): Let Amazon Q take action: generate code, edit files, automate Git workflows, resolve merge conflicts, and more — with your permission.\n\n## ⚡️ Installation\n\n- **macOS**:\n  - **DMG**: Download from AWS:\n    [aws.amazon.com](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html)\n  - **Homebrew**: `brew install amazon-q`\n- **Linux**:\n  - [Ubuntu/Debian](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-ubuntu)\n  - [AppImage](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-appimage)\n  - [Alternative Linux builds](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-alternative-linux)\n- **Windows**:\n  - Follow the discussions for\n    [Windows](https://github.com/aws/q-command-line-discussions/discussions/15)\n  - Or [use it on Window with WSL](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-windows)\n- **Remote machines**\n  - [Autocomplete in SSH](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete-ssh.html)\n\n\n## 🚀 Start Contributing\n\n### Prerequisites\n\n- MacOS\n  - Xcode 13 or later\n  - Brew\n\n### 1. Clone repo\n\n```shell\ngit clone https://github.com/aws/amazon-q-for-command-line.git\n```\n\n### 2. Setup\nHassle-free setup:\n```shell\nnpm run setup\n```\n\nOr if you'd like to DIY:\n\n\u003cdetails\u003e\n\u003csummary\u003eManual Setup\u003c/summary\u003e\n\u003cdiv\u003e\n\n### 1. Install platform dependencies\n\nFor Debian/Ubuntu:\n\n```shell\nsudo apt update\nsudo 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-compiler\n```\n### 2. Install Rust toolchain using [Rustup](https://rustup.rs):\n\n```shell\ncurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\nrustup default stable\n```\n\nFor pre-commit hooks, the following commands are required:\n\n```shell\nrustup toolchain install nightly\ncargo install typos-cli\n```\n\nFor MacOS development make sure the right targets are installed:\n\n```shell\nrustup target add x86_64-apple-darwin\nrustup target add aarch64-apple-darwin\n```\n\n### 3. Setup Python and Node using [`mise`](https://mise.jdx.dev)\n\nAdd mise integrations to your shell:\n\nFor zsh:\n```shell\necho 'eval \"$(mise activate zsh)\"' \u003e\u003e \"${ZDOTDIR-$HOME}/.zshrc\"\n```\n\nFor bash:\n```shell\necho 'eval \"$(mise activate bash)\"' \u003e\u003e ~/.bashrc\n```\n\nFor fish:\n```shell\necho 'mise activate fish | source' \u003e\u003e ~/.config/fish/config.fish\n```\n\nInstall the Python and Node toolchains using:\n\n```shell\nmise trust\nmise install\n```\n\n### 4. Setup precommit hooks\n\nRun `pnpm` in root directory to add pre-commit hooks:\n\n```shell\npnpm install --ignore-scripts\n```\n\n\u003c/div\u003e\n\u003c/details\u003e\n\n\n### 3. Start Local Development\nTo compile and view changes made to `q chat`:\n```shell\ncargo run --bin q_cli -- chat\n```\n\n\u003e If you are working on other q commands, just replace `chat` with the command name \n\nTo run tests for the Q CLI crate:\n```shell\ncargo test -p q_cli\n```\n\nTo format Rust files:\n```shell\ncargo +nightly fmt\n```\n\nTo run clippy:\n```shell\ncargo clippy --locked --workspace --color always -- -D warnings\n```\n\n\n\n### 💡 Quick Tip for Onboarding\n\nUse Q CLI to help you onboard Q CLI! \n\nStart a `q chat` session:\n\n```shell\nq chat\n```\n\nOnce inside `q chat`, you can supply project context by adding the [`codebase-summary.md`](codebase-summary.md) file:\n\n```shell\n/context add codebase-summary.md\n```\n\nThis enables Q to answer onboarding questions like:\n\n- “What does this crate do?”\n\n- “Where is X implemented?”\n\n- “How do these components interact?”\n\nGreat for speeding up your ramp-up and navigating the repo more effectively.\n\n\n\n\n## 🏗️ Project Layout\n\nSeveral projects live here:\n\n- [`autocomplete`](packages/autocomplete/) - The autocomplete react app\n- [`dashboard`](packages/dashboard-app/) - The dashboard react app\n- [`figterm`](crates/figterm/) - figterm, our headless terminal/pseudoterminal that\n  intercepts the user’s terminal edit buffer.\n- [`q_cli`](crates/q_cli/) - the `q` CLI, allows users to interface with Amazon Q Developer from\n  the command line\n- [`fig_desktop`](crates/fig_desktop/) - the Rust desktop app, uses\n  [`tao`](https://docs.rs/tao/latest/tao/)/[`wry`](https://docs.rs/wry/latest/wry/)\n  for windowing/webviews\n- [`fig_input_method`](crates/fig_input_method/) - The input method used to get cursor\n  position on macOS\n- [`vscode`](extensions/vscode/) - Contains the VSCode plugin needed\n  for the Amazon Q Developer for command line to work in VSCode\n- [`jetbrains`](extensions/jetbrains/) - Contains the VSCode plugin\n  needed for the Amazon Q Developer for command line to work in Jetbrains IDEs\n\nOther folder to be aware of\n\n- [`build-scripts/`](build-scripts/) - Contains all python scripts to build,\n  sign, and test the project on macOS and Linux\n- [`crates/`](crates/) - Contains all internal rust crates\n- [`packages/`](packages/) - Contains all internal npm packages\n- [`proto/`](proto/) -\n  [protocol buffer](https://developers.google.com/protocol-buffers/) message\n  specification for inter-process communication\n- [`tests/`](tests/) - Contain integration tests for the projects\n\nBelow is a high level architecture of how the different components of the app and\ntheir IPC:\n\n![architecture](docs/assets/architecture.svg)\n\n\n\n\n## 🛡️ Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## 📜 Licensing\n\nThis repo is dual licensed under MIT and Apache 2.0 licenses.\n\n“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.\n","funding_links":[],"categories":["🚀 AI Tools for Vim, Neovim, and Terminal","📚 Projects (1974 total)","Rust","typescript","Repos","Developer \u0026 Coding Assistants","Uncategorized","Terminal \u0026 CLI Agents"],"sub_categories":["Tools \u0026 Libraries","Code Generation \u0026 Refactoring","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws%2Famazon-q-developer-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faws%2Famazon-q-developer-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws%2Famazon-q-developer-cli/lists"}