forked from blitz-js/blitzjs.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for the new cli command (blitz-js#138)
- Loading branch information
1 parent
5667da8
commit f4306b1
Showing
2 changed files
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
title: blitz autocomplete | ||
sidebar_label: blitz autocomplete | ||
--- | ||
|
||
Displays autocomplete installation instructions. | ||
|
||
> **Note**: Autocomplete currently [doesn't work on Windows](https://github.com/oclif/plugin-autocomplete/issues/2) | ||
```bash | ||
blitz autocomplete [shell] | ||
``` | ||
|
||
| Argument | Required | Description | | ||
| -------- | -------- | --------------- | | ||
| `shell` | No | `zsh` or `bash` | | ||
|
||
#### Example Output | ||
|
||
```bash | ||
> blitz autocomplete zsh | ||
|
||
Building the autocomplete cache... done | ||
|
||
Setup Instructions for BLITZ CLI Autocomplete --- | ||
|
||
1) Add the autocomplete env var to your zsh profile and source it | ||
$ printf "$(blitz autocomplete:script zsh)" >> ~/.zshrc; source ~/.zshrc | ||
|
||
NOTE: After sourcing, you can run `$ compaudit -D` to ensure no permissions conflicts are present | ||
|
||
2) Test it out, e.g.: | ||
$ blitz <TAB> # Command completion | ||
$ blitz command --<TAB> # Flag completion | ||
|
||
Enjoy! | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters