Skip to content

Commit

Permalink
Add documentation for the new cli command (blitz-js#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
karaggeorge authored Sep 2, 2020
1 parent 5667da8 commit f4306b1
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/cli-autocomplete.mdx
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!
```
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ module.exports = {
"cli-generate",
"cli-console",
"cli-install",
"cli-autocomplete",
],
Recipes: ["using-recipes", "writing-recipes"],
Templates: ["templates"],
Expand Down

0 comments on commit f4306b1

Please sign in to comment.