autocomplete

[![Badge: macOS](https://img.shields.io/badge/os-%20macOS-light)](#)
[![Badge: Documentation](https://img.shields.io/badge/documentation-black)](https://fig.io/docs/)
[![Badge: contributors](https://img.shields.io/github/contributors/withfig/autocomplete)](#Contributors)

**[Amazon Q Developer CLI](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html)**
adds IDE-style completions for hundreds of popular CLIs like `git`, `npm`,
`docker`, and `aws`. Start typing, and Amazon Q populates contextually relevant
subcommands, options and arguments.

> Amazon Q Developer CLI, formerly known as [Fig](https://fig.io), is open source. See [aws/amazon-q-developer-cli]( https://github.com/aws/amazon-q-developer-cli) to learn more.

## ⚡️ Installation

- **macOS**:
  - **DMG**: Download from AWS:
    [aws.amazon.com](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html)
  - **Homebrew**: `brew install amazon-q`
- **Linux/Windows**:
  - Follow the discussions for
    [Linux](https://github.com/aws/q-command-line-discussions/discussions/14) or
    [Windows](https://github.com/aws/q-command-line-discussions/discussions/15)
- **Remote machines**
  - [Autocomplete in SSH](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete-ssh.html)

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

<br/>

![Demo of Amazon Q's CLI Completions in a terminal](https://docs.aws.amazon.com/images/amazonq/latest/qdeveloper-ug/images/command-line-completions.gif)

<br/>

## 👋 What are "completion specs"?

A completion spec is a _declarative_ schema that specifies the `subcommands`,
`options` and `args` for a CLI tool. Amazon Q uses these schemas to generate
suggestions.

<br/>

## 😎 Contribute your first spec in < 3 minutes

Use the steps below or follow our getting started guide:
[fig.io/docs](https://fig.io/docs)

**Prerequisites:**

- Download Amazon Q for command line
- Node and Pnpm

<br/>

**Steps**

1. Make sure you have `pnpm` [installed](https://pnpm.io/installation), as
   that's the package manager used in this repo.

2. Click [here](https://GitHub.com/withfig/autocomplete/fork/) to fork this
   repo.

3. Clone your forked repo and create an example spec

   ```bash
   # Replace `YOUR_GITHUB_USERNAME` with your own GitHub username
   git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git autocomplete
   cd autocomplete

   # Add withfig/autocomplete as a remote
   git remote add upstream https://github.com/withfig/autocomplete.git

   # Install packages
   pnpm 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 type `abc[space]`. Your example spec will appear.
   😊

#### Other things to know

- Edit your spec in TypeScript in the `src/` folder
- On save, specs are compiled to the `build/` folder
- In **de