mirror of
https://github.com/onyx-and-iris/xair-cli.git
synced 2026-04-08 18:03:37 +00:00
add ToC to README
add Shell Completion section to README
This commit is contained in:
38
README.md
38
README.md
@@ -1,5 +1,15 @@
|
|||||||
# xair-cli
|
# xair-cli
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Use](#use)
|
||||||
|
- [Shell Completion](#shell-completion)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
*xair-cli*
|
*xair-cli*
|
||||||
@@ -113,6 +123,34 @@ xair-cli snapshot 20 save 'twitch live'
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Shell Completion
|
||||||
|
|
||||||
|
- completion:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- args: Shell
|
||||||
|
- If no shell is passed completion will attempt to detect the current login shell.
|
||||||
|
|
||||||
|
*xair-cli*
|
||||||
|
|
||||||
|
```console
|
||||||
|
xair-cli completion
|
||||||
|
|
||||||
|
xair-cli completion bash
|
||||||
|
```
|
||||||
|
|
||||||
|
*x32-cli*
|
||||||
|
|
||||||
|
```console
|
||||||
|
x32-cli completion
|
||||||
|
|
||||||
|
x32-cli completion bash
|
||||||
|
```
|
||||||
|
|
||||||
|
Currently supported shells: *bash* *zsh* *fish*.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
`xair-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
`xair-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||||
|
|||||||
Reference in New Issue
Block a user