Repository files navigation

Amazon Q Developer CLIadds IDE-style completions for hundreds of popular CLIs likegit,npm,docker, andaws. Start typing, and Amazon Q populates contextually relevantsubcommands, options and arguments.

Amazon Q Developer CLI, formerly known asFig, is open source. Seeaws/amazon-q-developer-cli to learn more.

• macOS:
  • DMG: Download from AWS:aws.amazon.com
  • Homebrew:brew install amazon-q
• Linux/Windows:
  • Follow the discussions forLinux orWindows
• Remote machines
  • Autocomplete in SSH

NOTE: Once it's downloaded, launch the app to set up Amazon Q for commandline!

A completion spec is adeclarative schema that specifies thesubcommands,options andargs for a CLI tool. Amazon Q uses these schemas to generatesuggestions.

Use the steps below or follow our getting started guide:fig.io/docs

Prerequisites:

• Download Amazon Q for command line
• Node and Pnpm

Steps

1. Make sure you havepnpminstalled, asthat's the package manager used in this repo.

2. Clickhere to fork thisrepo.

3. Clone your forked repo and create an example spec

   # Replace `YOUR_GITHUB_USERNAME` with your own GitHub usernamegit clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git autocompletecd autocomplete# Add withfig/autocomplete as a remotegit remote add upstream https://github.com/withfig/autocomplete.git# Install packagespnpm install# Create an example spec (call it "abc")pnpm create-spec abc# Turn on "dev mode"pnpm dev

4. Now go to your terminal and typeabc[space]. Your example spec will appear.😊

• Edit your spec in TypeScript in thesrc/ folder
• On save, specs are compiled to thebuild/ folder
• Indev mode, specs are read from thebuild folder, and generators runevery keystroke.

# Typecheck all specs in the src/ folderpnpmtest# Compile typescripts specs from src/ folder to build/ folderpnpm build# Lint and fix issuespnpm lint:fix

We would love contributions for:

• New completion specs
• Errors with existing completion specs (e.g. missing subcommands, options, orarguments)
• Generatorsfor argument suggestions
• Better descriptions, icons etc
• Themes!

If you aren't able to contribute, please feel free to open anissue.

Amazon Q for command line works with the native macOS Terminal app,iTerm,Tabby,Hyper,Kitty,WezTerm, andAlacritty. It also works in theintegrated terminals ofVSCode,JetBrains IDEs,Android Studio, andNova.

Want to see another terminal included? Check ourissue tracker and add yoursupport for it!

Amazon Q for command line uses the Accessibility API on Mac to position thewindow, and integrates with your shell to read what you've typed.

Not yet, Amazon Q for command line is only available on macOS for now.Windows andLinuxsupport is in progress!

Runbrew install amazon-q or, downloading the app ataws.amazon.com.Then, launch the Amazon Q app!

Check out ourHow to Contribute guide.Many of Amazon Q's 400+ contributors made their first open source contributionto Amazon Q!

Runq doctor to automatically debug issues with your installation. Otherwisemake an issue in our GitHub discussions community:aws/q-command-line-discussions