Easily create a feature-rich command-line application in 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 "$0" "$@")" into script to let argc to parse command line arguments.Write example.sh
```sh
eval "$(argc "$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] [value notation] [help string]
Define a positional argument.
```sh
_fn A positional argument with default value from fn_fn] A positional argument with choices from fn_fn] A required positional argument with choices from fn```
@option [short] <long>[modifier] [value notation] [help string]
Define a option.
```sh
_fn A option with default value from fn_fn] A option with choices from fn_fn] A required option with choices from 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] ```
@help string
Enable help subcommand.
```sh
test() { echo Run test } ```
```
USAGE: test.sh
COMMANDS: help Show help foo Run test ```
```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 directorycompletion scripts are available for bash/zsh/fish/powershell.
All argc scripts share the same completion function. To add completion to a argc script, simply add the script name to $ARGC_SCRIPTS.
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.