{"id":13453858,"url":"https://github.com/withfig/autocomplete","last_synced_at":"2025-05-12T18:16:36.212Z","repository":{"id":36999784,"uuid":"299482335","full_name":"withfig/autocomplete","owner":"withfig","description":"IDE-style autocomplete for your existing terminal \u0026 shell","archived":false,"fork":false,"pushed_at":"2025-05-05T17:15:31.000Z","size":38860,"stargazers_count":24909,"open_issues_count":178,"forks_count":5518,"subscribers_count":89,"default_branch":"master","last_synced_at":"2025-05-12T18:15:25.896Z","etag":null,"topics":["autocomplete","bash","cli","fig","fish","hacktoberfest","iterm2","macos","shell","terminal","typescript","zsh"],"latest_commit_sha":null,"homepage":"https://fig.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/withfig.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"withfig"}},"created_at":"2020-09-29T02:21:06.000Z","updated_at":"2025-05-12T17:18:26.000Z","dependencies_parsed_at":"2023-01-17T12:47:40.574Z","dependency_job_id":"1bcc441e-66e6-4e81-82af-8c177268ff1c","html_url":"https://github.com/withfig/autocomplete","commit_stats":{"total_commits":4249,"total_committers":523,"mean_commits":8.124282982791588,"dds":0.7411155566015533,"last_synced_commit":"749b148e8320f12f5599c0bf701c612e2764d9a0"},"previous_names":[],"tags_count":1555,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/withfig%2Fautocomplete/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/withfig","download_url":"https://codeload.github.com/withfig/autocomplete/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253795162,"owners_count":21965488,"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":["autocomplete","bash","cli","fig","fish","hacktoberfest","iterm2","macos","shell","terminal","typescript","zsh"],"created_at":"2024-07-31T08:00:48.592Z","updated_at":"2025-05-12T18:16:36.186Z","avatar_url":"https://github.com/withfig.png","language":"TypeScript","readme":"[![Badge: macOS](https://img.shields.io/badge/os-%20macOS-light)](#)\n[![Badge: Documentation](https://img.shields.io/badge/documentation-black)](https://fig.io/docs/)\n[![Badge: contributors](https://img.shields.io/github/contributors/withfig/autocomplete)](#Contributors)\n\n**[Amazon Q Developer CLI](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html)**\nadds IDE-style completions for hundreds of popular CLIs like `git`, `npm`,\n`docker`, and `aws`. Start typing, and Amazon Q populates contextually relevant\nsubcommands, options and arguments.\n\n\u003e 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.\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/Windows**:\n  - Follow the discussions for\n    [Linux](https://github.com/aws/q-command-line-discussions/discussions/14) or\n    [Windows](https://github.com/aws/q-command-line-discussions/discussions/15)\n- **Remote machines**\n  - [Autocomplete in SSH](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete-ssh.html)\n\n\u003e NOTE: Once it's downloaded, launch the app to set up Amazon Q for command\n\u003e line!\n\n\u003cbr/\u003e\n\n![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)\n\n\u003cbr/\u003e\n\n## 👋 What are \"completion specs\"?\n\nA completion spec is a _declarative_ schema that specifies the `subcommands`,\n`options` and `args` for a CLI tool. Amazon Q uses these schemas to generate\nsuggestions.\n\n\u003cbr/\u003e\n\n## 😎 Contribute your first spec in \u003c 3 minutes\n\nUse the steps below or follow our getting started guide:\n[fig.io/docs](https://fig.io/docs)\n\n**Prerequisites:**\n\n- Download Amazon Q for command line\n- Node and Pnpm\n\n\u003cbr/\u003e\n\n**Steps**\n\n1. Make sure you have `pnpm` [installed](https://pnpm.io/installation), as\n   that's the package manager used in this repo.\n\n2. Click [here](https://GitHub.com/withfig/autocomplete/fork/) to fork this\n   repo.\n\n3. Clone your forked repo and create an example spec\n\n   ```bash\n   # Replace `YOUR_GITHUB_USERNAME` with your own GitHub username\n   git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git autocomplete\n   cd autocomplete\n\n   # Add withfig/autocomplete as a remote\n   git remote add upstream https://github.com/withfig/autocomplete.git\n\n   # Install packages\n   pnpm install\n\n   # Create an example spec (call it \"abc\")\n   pnpm create-spec abc\n\n   # Turn on \"dev mode\"\n   pnpm dev\n   ```\n\n4. Now go to your terminal and type `abc[space]`. Your example spec will appear.\n   😊\n\n#### Other things to know\n\n- Edit your spec in TypeScript in the `src/` folder\n- On save, specs are compiled to the `build/` folder\n- In **dev mode**, specs are read from the `build` folder, and generators run\n  every keystroke.\n\n\u003cbr\u003e\n\n## 📦 Other available package.json commands\n\n```bash\n# Typecheck all specs in the src/ folder\npnpm test\n\n# Compile typescripts specs from src/ folder to build/ folder\npnpm build\n\n# Lint and fix issues\npnpm lint:fix\n```\n\n## 🔥 Contributions\n\nWe would love contributions for:\n\n- New completion specs\n- Errors with existing completion specs (e.g. missing subcommands, options, or\n  arguments)\n- [Generators](https://fig.io/docs/getting-started/generating-argument-suggestions)\n  for argument suggestions\n- Better descriptions, icons etc\n- [Themes](https://github.com/withfig/themes)!\n\nIf you aren't able to contribute, please feel free to open an\n[issue](https://github.com/withfig/autocomplete/issues/new/choose).\n\n## 🙋‍♀️ FAQ\n\n#### What terminals does Amazon Q work with?\n\nAmazon Q for command line works with the native macOS Terminal app, [iTerm],\n[Tabby], [Hyper], [Kitty], [WezTerm], and [Alacritty]. It also works in the\nintegrated terminals of [VSCode], [JetBrains IDEs], [Android Studio], and\n[Nova].\n\n[iterm]: https://iterm2.com\n[tabby]: https://tabby.sh\n[hyper]: https://hyper.is\n[kitty]: https://sw.kovidgoyal.net/kitty\n[wezterm]: https://wezfurlong.org/wezterm/\n[alacritty]: https://alacritty.org/\n[vscode]: https://code.visualstudio.com/\n[jetbrains ides]: https://www.jetbrains.com/\n[android studio]: https://developer.android.com/studio\n[nova]: https://nova.app/\n\nWant to see another terminal included? Check our\n[issue tracker](https://github.com/aws/q-command-line-discussions) and add your\nsupport for it!\n\n#### How does Amazon Q for command line work?\n\nAmazon Q for command line uses the Accessibility API on Mac to position the\nwindow, and integrates with your shell to read what you've typed.\n\n#### Does Amazon Q for command line work on Windows or Linux?\n\nNot yet, Amazon Q for command line is only available on macOS for now.\n[Windows](https://github.com/aws/q-command-line-discussions/discussions/15) and\n[Linux](https://github.com/aws/q-command-line-discussions/discussions/14)\nsupport is in progress!\n\n#### How can I download Amazon Q?\n\nRun `brew install amazon-q` or, downloading the app at\n[aws.amazon.com](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-getting-started-installing.html).\nThen, launch the Amazon Q app!\n\n#### How do I submit a PR?\n\nCheck out our\n[How to Contribute](https://fig.io/docs/getting-started/contributing) guide.\nMany of Amazon Q's 400+ contributors made their first open source contribution\nto Amazon Q!\n\n#### Amazon Q for command line doesn't work for me!\n\nRun `q doctor` to automatically debug issues with your installation. Otherwise\nmake an issue in our GitHub discussions community:\n[aws/q-command-line-discussions](https://github.com/aws/q-command-line-discussions/discussions)\n\n\u003cbr/\u003e\n\n## ✨ Contributors\n\n\u003ca href=\"https://github.com/withfig/autocomplete/graphs/contributors\"\u003e\n  \u003cimg alt=\"Grid of profile icons of the 400+ contributors\" src=\"https://contrib.rocks/image?repo=withfig/autocomplete\" /\u003e\n\u003c/a\u003e\n","funding_links":["https://github.com/sponsors/withfig"],"categories":["效率增强与辅助","HarmonyOS","TypeScript","开源工具","语言资源库","终端","bash","Packages","cli","命令行工具","Utilities","zsh","\u003ca name=\"utility\"\u003e\u003c/a\u003eUtilities","Repository app"],"sub_categories":["Windows Manager","命令行工具","typescript","网络服务_其他","CLI Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithfig%2Fautocomplete","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwithfig%2Fautocomplete","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithfig%2Fautocomplete/lists"}