fix cli
This commit is contained in:
parent
5b035fe12c
commit
14b4f08147
3 changed files with 50 additions and 29 deletions
32
docs/cli-arguments.md
Normal file
32
docs/cli-arguments.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
# CLI Arguments
|
||||
|
||||
Add `-h` or `--help` to any subcommand to view its help.
|
||||
|
||||
## Run (`run`)
|
||||
|
||||
```txt
|
||||
Usage: gregory run [OPTIONS]
|
||||
```
|
||||
|
||||
**Options:**
|
||||
|
||||
- `-c`, `--config`: Path to the config file; default: `gregory.yml`
|
||||
<!-- - `-d`, `--daemonize`: Whether to daemonize the program - not yet supported -->
|
||||
|
||||
## Generate shell completions `gen-completion`
|
||||
|
||||
```txt
|
||||
Usage: gregory gen-completion [OPTIONS] <COMMAND>
|
||||
```
|
||||
|
||||
**Commands:**
|
||||
|
||||
- bash
|
||||
- zsh
|
||||
- fish
|
||||
- elvish
|
||||
- powershell
|
||||
|
||||
**Options:**
|
||||
|
||||
- `-b`, `--binary-name`: The name of the binary; default: `gregory`
|
Loading…
Add table
Add a link
Reference in a new issue