{"id":23689503,"url":"https://github.com/gutenye/commander-completion-carapace","last_synced_at":"2025-10-29T01:03:40.302Z","repository":{"id":269782199,"uuid":"908446319","full_name":"gutenye/commander-completion-carapace","owner":"gutenye","description":"Effortlessly add intelligent autocomplete support to your Commander.js CLI app using Carapace. Supports Bash, Zsh, Fish, Nushell and more","archived":false,"fork":false,"pushed_at":"2024-12-28T08:27:28.000Z","size":188,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-05T18:03:08.405Z","etag":null,"topics":["autocomplete","bash","carapace","commander","commanderjs","complete","completion","fish","nushell","zsh"],"latest_commit_sha":null,"homepage":"","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/gutenye.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-26T05:14:31.000Z","updated_at":"2024-12-28T08:27:31.000Z","dependencies_parsed_at":"2024-12-26T06:34:52.550Z","dependency_job_id":null,"html_url":"https://github.com/gutenye/commander-completion-carapace","commit_stats":null,"previous_names":["gutenye/commander-completion-carapace"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutenye%2Fcommander-completion-carapace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutenye%2Fcommander-completion-carapace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutenye%2Fcommander-completion-carapace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutenye%2Fcommander-completion-carapace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gutenye","download_url":"https://codeload.github.com/gutenye/commander-completion-carapace/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239751797,"owners_count":19690924,"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","carapace","commander","commanderjs","complete","completion","fish","nushell","zsh"],"created_at":"2024-12-30T00:52:28.990Z","updated_at":"2025-10-29T01:03:40.297Z","avatar_url":"https://github.com/gutenye.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ⌘ Commander Completion Carapace ⌘\n\n[![Stars](https://img.shields.io/github/stars/gutenye/commander-completion-carapace?style=social)](https://github.com/gutenye/commander-completion-carapace) [![NPM Version](https://img.shields.io/npm/v/@gutenye/commander-completion-carapace)](https://www.npmjs.com/package/@gutenye/commander-completion-carapace) [![License](https://img.shields.io/github/license/gutenye/commander-completion-carapace?color=blue)](https://github.com/gutenye/commander-completion-carapace/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue)](https://github.com/gutenye/commander-completion-carapace#-contribute)\n\nEffortlessly add intelligent autocomplete support to your [Commander.js](https://github.com/tj/commander.js) CLI app using [Carapace](https://github.com/carapace-sh/carapace-bin).\n It works with a wide range of shells, making your CLI tools more intuitive and user-friendly.\n\n**Show your ❤️ and support by starring this project and following the author, [Guten Ye](https://github.com/gutenye)!**\n\n\u003ca target=\"_blank\" href=\"https://asciinema.org/a/GyJv0xAaZqGp9k1TFNcnaiB9y\"\u003e![screenrecording](https://asciinema.org/a/GyJv0xAaZqGp9k1TFNcnaiB9y.svg)\u003c/a\u003e\n\n## 🌟 Features\n\n- ⌘ **Multiple Shells Support**: Works with Bash, Zsh, Fish, Nushell, and more.\n- 🚄 **Blazing Fast Completion**: Experience instantaneous completion with no delays.\n- 🔗 **Carapace Integration**: Unlock all the powerful features of Carapace, including advanced shell completions.\n- 🧑‍💻 **Effortless Integration**: Easily add completion support to your Commander.js based CLI app.\n\n## 🚀 Getting Started\n\n### 1️⃣ Install\n\nFirst, make sure Carapace is installed, as it powers the completion functionality:\n\n```sh\nbun add @gutenye/commander-completion-carapace commander\n```\n\n### 2️⃣ Write Completion Code\n\nNow, integrate completion support into your Commander.js application by adding the following code:\n\n```ts\nimport { program, Option } from '@gutenye/commander-completion-carapace'\n\nprogram\n  .name('hello')\n  .enableCompletion()\n\nprogram.command('cmd1 [...files]')\n  .description('Description')\n  .option('--option1', 'Description')\n  .completion({   // pass to carapace \n    positionalany: ['$files'] // dynamic completion\n  })\n  .action(() =\u003e {})\n\nawait program.installCompletion() // Creates hello.yaml Carapace spec file\n\nprogram.parse()\n```\n\n### 3️⃣ Use the Completion\n\n```sh\nhello      # Will create the Carapace spec file the first time it runs\nhello\u003cTab\u003e # Press Tab to see completions for commands and options\n```\n\n## 🤝 Contribute\n\nWe welcome contributions! Whether it’s bug reports, feature suggestions, or pull requests, your involvement makes this project better.\n\n**How to Contribute:**\n\n1. Fork the Repository\n2. Open a Pull Request on Github\n\n---\n\nThank you for using Commander Completion Carapace! ✨ If you found it helpful, please ⭐️ star the project ️️⭐ on GitHub. If you encounter any issues, feel free to report an issue on Github.\n\n**Special thanks to all the contributors:**\n\n[![](https://contrib.rocks/image?repo=gutenye/commander-completion-carapace)](https://github.com/gutenye/commander-completion-carapace/graphs/contributors)\n\n[⬆ Back to top ⬆](#readme)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgutenye%2Fcommander-completion-carapace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgutenye%2Fcommander-completion-carapace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgutenye%2Fcommander-completion-carapace/lists"}