Skip to content

Commit 2e68892

Browse files
committed
readme
1 parent 37fdf3b commit 2e68892

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,30 @@ All commands are listed on https://nuxt.com/docs/api/commands.
88

99
## Shell Autocompletions
1010

11-
Nuxi now supports shell autocompletions for `zsh`, `bash`, `fish`, and `powershell`, powered by [`@bomb.sh/tab`](https://github.com/bombshell-dev/tab).
11+
Nuxi provides shell autocompletions for commands, options, and option values powered by [`@bomb.sh/tab`](https://github.com/bombshell-dev/tab).
12+
13+
### Setup
1214

1315
For permanent setup in zsh, add this to your `~/.zshrc`:
1416

1517
```bash
16-
source <(vitest complete zsh)
17-
# same can be done for other shells
18+
# Add to ~/.zshrc for permanent autocompletions (same can be done for other shells)
19+
source <(nuxi complete zsh)
1820
```
19-
For more information, see [bomb.sh/tab](https://bomb.sh/docs/tab/).
21+
22+
### Package Manager Integration
23+
24+
`@bomb.sh/tab` integrates with [package managers](https://github.com/bombshell-dev/tab?tab=readme-ov-file#package-manager-completions). Autocompletions work when running nuxi directly:
25+
26+
```bash
27+
npx nuxi <Tab>
28+
npm exec nuxi <Tab>
29+
pnpm nuxi <Tab>
30+
yarn nuxi <Tab>
31+
bun nuxi <Tab>
32+
```
33+
34+
For package manager autocompletions, you should install [tab's package manager completions](https://github.com/bombshell-dev/tab?tab=readme-ov-file#package-manager-completions) separately.
2035

2136
## Contributing
2237

0 commit comments

Comments
 (0)