An elegant command-line options, arguments and sub-commands parser for bash.
cargo install argc
Download from Github Releases, unzip and add argc to your $PATH.
extractions/setup-crate can be used to install just in a GitHub Actions workflow.
yaml
- uses: extractions/setup-crate@v1
with:
owner: sigoden
name: argc
To write a command-line program with argc, we only need to do two things:
eval "$(argc --argc-eval "$0" "$@")" into script to let argc to parse command line arguments.Write example.sh
```sh
eval "$(argc --argc-eval "$0" "$@")" echo foo: $argcfoo echo bar: $argcbar echo baz: ${argc_baz[@]} ```
Run ./example.sh --foo --bar=value --baz a b c, you can see argc successfully parses arguments and generate variables with argc_ prefix.
foo: 1
bar: value
baz: a b c
Run ./example.sh -h, argc wll print help information for you.
``` USAGE: example.sh [OPTIONS]
OPTIONS:
--foo A flag
--bar
argc parses cli definition from comment tags.
@cmd [string]
Define a subcommand
```sh
upload() { echo Run upload }
download() { echo Run download } ```
```
USAGE: test.sh
COMMANDS: upload Upload a file download Download a file ```
@arg <name>[modifier|default|modifer+choices] [zero-or-one value notation] [help-string]
Define a positional argument.
```sh
_fn A positional argument with default value fn_fn] A positional argument with choices fn```
@option [short] <long>[modifier|default|modifier+choices] [value-notation]... [help-string]
Define a option.
```sh
_fn A option with default value fn_fn] A option with choices fn```
@flag [short] <long>[*] [help string]
Define a flag. A flag is an option of boolean type, and is always false by default (e.g. --verbose, --quiet, --all, --long, etc).
```sh
```
@alias <name...>
Add aliases for subcommand.
```sh
test() { echo Run test } ```
```
USAGE: test.sh
COMMANDS: test Run tests [aliases: t, tst] ```
```sh
test() { echo Run test } ```
``` test.sh 2.17.1 nobody nobody@example.com A demo cli
USAGE: test.sh
COMMANDS: test Run test ```
Value notation is used to describe value type of options and positional parameters.
```
```
Here are some value notation that will affect the shell completion.
<FILE>: complete files in current directory<DIR>: complete directories in current directory<PATH>: complete files and directories in current directoryEnsure argc is added to $PATH. Then register the completion
```
source <(argc --argc-completions bash mycmd1 mycmd2)
argc --argc-completions fish mycmd1 mycmd2 | source
argc --argc-completions powershell mycmd1 mycmd2 | Out-String | Invoke-Expression
source <(argc --argc-completions zsh mycmd1 mycmd2) ```
Replace mycmd1 mycmd2 with your argc script names.
Argc can be used as multiple shell completion engine. see argc-compteltions
We can create a script called Argcscript.sh. If argc is run without the --argc-* options, argc will locate the file and run it.
what is the benefit?
You can use argc --argc-create to quickly create boilerplate Argcscripts.
To migrate from v0 to v1, the only thing you need to do is:
Replace eval "$(argc "$0" "$@")" with eval "$(argc --argc-eval "$0" "$@")" in your script.
Otherwise you may encounter an error message like this when running the script:
Not found argcscript, try `argc --argc-help` to get help.
Argc requires bash to run scripts. git's built-in bash is good enough for argc.
If you want to use another bash, please specify it via ARGC_SHELL environment variable.
If you want to run the bash script directly, you can add the following configuration to Windows Registry.
New-ItemProperty -LiteralPath 'HKLM:\SOFTWARE\Classes\sh_auto_file\shell\open\command' `
-Name '(default)' -Value '"C:\Program Files\Git\bin\bash.exe" "%1" %*' -PropertyType String -Force
Copyright (c) 2022 argc-developers.
argc is made available under the terms of either the MIT License or the Apache License 2.0, at your option.
See the LICENSE-APACHE and LICENSE-MIT files for license details.