Skip to content

Commit

Permalink
docs: cli shell completion
Browse files Browse the repository at this point in the history
  • Loading branch information
ekristen committed Sep 18, 2024
1 parent bbfc2f1 commit c762e84
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/cli-completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# CLI Shell Completion

The CLI supports shell completion for bash, and zsh. The completion script can be generated by running the
following command:

```console
$ aws-nuke completion
```

By default, the shell is `bash` unless it can detect the shell you are using. You may specify the shell by using the
`--shell` flag.

The command will not install the completion script for you, but it will output the script to the console. You can
redirect the output to a file and source it in your shell to enable completion.

Command and flag completion is supported, however for flags that require a value, the completion will not provide a list
of possible values.

!!! warning
For flag completion to work you often need to supply only the first `-` and press tab, depending on your shell
configuration `--` followed by a tag will execute the command.

## Examples

!!! note
The following are examples of commands you can run depending on your operating system and shell configuration.

### bash

```console
aws-nuke completion --shell bash > /etc/bash_completion.d/aws-nuke
```

### zsh

```console
aws-nuke completion --shell zsh > /usr/share/zsh/site-functions/_aws-nuke
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ nav:
- CLI:
- Usage: cli-usage.md
- Options: cli-options.md
- Shell Completion: cli-completion.md
- Experimental: cli-experimental.md
- Examples: cli-examples.md
- Config:
Expand Down

0 comments on commit c762e84

Please sign in to comment.