This commit is contained in:
askiiart 2024-12-22 18:26:40 -06:00
parent 5b035fe12c
commit 14b4f08147
Signed by untrusted user who does not match committer: askiiart
GPG key ID: EA85979611654C30
3 changed files with 50 additions and 29 deletions

32
docs/cli-arguments.md Normal file
View 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`