You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Shell autocompletions are largely missing in the JavaScript CLI ecosystem. Tab provides a simple API for adding autocompletions to any JavaScript CLI tool.
5
+
Shell autocompletions are largely missing in the JavaScript CLI ecosystem. tab provides a simple API for adding autocompletions to any JavaScript CLI tool.
6
6
7
7
Additionally, tab supports autocompletions for `pnpm`, `npm`, `yarn`, and `bun`.
8
8
9
9
As CLI tooling authors, if we can spare our users a second or two by not checking documentation or writing the `-h` flag, we're doing them a huge favor. The unconscious mind loves hitting the [TAB] key and always expects feedback. When nothing happens, it breaks the user's flow - a frustration apparent across the whole JavaScript CLI tooling ecosystem.
10
10
11
-
Tab solves this complexity by providing autocompletions that work consistently across `zsh`, `bash`, `fish`, and `powershell`.
11
+
tab solves this complexity by providing autocompletions that work consistently across `zsh`, `bash`, `fish`, and `powershell`.
12
12
13
13
## Installation
14
14
@@ -91,7 +91,7 @@ yarn add --emoji=<TAB>
91
91
92
92
## Framework Adapters
93
93
94
-
Tab provides adapters for popular JavaScript CLI frameworks.
94
+
tab provides adapters for popular JavaScript CLI frameworks.
95
95
96
96
### CAC Integration
97
97
@@ -194,7 +194,7 @@ if (portOption) {
194
194
program.parse();
195
195
```
196
196
197
-
Tab uses a standardized completion protocol that any CLI can implement:
197
+
tab uses a standardized completion protocol that any CLI can implement:
198
198
199
199
```bash
200
200
# Generate shell completion script
@@ -218,4 +218,15 @@ See [bombshell docs](https://bomb.sh/docs/tab/).
218
218
219
219
## Contributing
220
220
221
-
We welcome contributions! Tab's architecture makes it easy to add support for new package managers or CLI frameworks.
221
+
We welcome contributions! tab's architecture makes it easy to add support for new package managers or CLI frameworks.
222
+
223
+
## Acknowledgments
224
+
225
+
tab was inspired by the great [Cobra](https://github.com/spf13/cobra/) project, which set the standard for CLI tooling in the Go ecosystem.
226
+
227
+
## Adoption Support
228
+
229
+
We want to make it as easy as possible for the JS ecosystem to enjoy great autocompletions.
230
+
We at [thundraa](https://thundraa.com) would be happy to help any **open source CLI utility** adopt **tab**.
231
+
If you maintain a CLI and would like autocompletions set up for your users, just [drop the details in our _Adopting tab_ discussion](https://github.com/bombshell-dev/tab/discussions/61).
232
+
We’ll gladly help and even open a PR to get you started.
0 commit comments