让我们用一个例子来说明

# @flag -F --foo  Flag param
# @option --bar   Option param
# @option --baz*  Option param (multi-occurs)
# @arg val*       Positional param

eval "$(argc --argc-eval "$0" "$@")"

echo foo: $argc_foo
echo bar: $argc_bar
echo baz: ${argc_baz[@]}
echo val: ${argc_val[@]}

使用一些示例参数运行脚本

./example.sh -F --bar=xyz --baz a --baz b v1 v2

Argc 解析这些参数并创建以 argc_ 为前缀的变量

foo: 1
bar: xyz
baz: a b
val: v1 v2

只需运行 ./example.sh --help，即可查看您的 CLI 自动生成的帮助信息

USAGE: example [OPTIONS] [VAL]...

ARGS:
  [VAL]...  Positional param

OPTIONS:
  -F, --foo           Flag param
      --bar <BAR>     Option param
      --baz [BAZ]...  Option param (multi-occurs)
  -h, --help          Print help
  -V, --version       Print version

通过这些简单的步骤，您就可以开始利用 Argc 并创建健壮的 CLI 程序了！

注释标签

注释标签是带有 @ 和特定标签的标准的 Bash 注释。它们为 Argc 提供了配置脚本功能的说明。

有关所有注释标签的语法和用法，请参阅 规范。

Argc-build

生成一个独立的 bash 脚本，其中包含当存在 argc 命令时通常可用的所有功能。

生成的脚本移除了 argc 依赖，增强了兼容性，并使部署到更广泛的环境中成为可能。

argc --argc-build <SCRIPT> [OUTPATH]

argc --argc-build ./example.sh build/

./build/example.sh -h     # The script's functionality does not require the `argc` dependency

Argcscript

Argc 还是为那些喜欢 Bash 脚本的高效性和灵活性而构建的命令运行器。

类似于 Makefile 为 make 工具定义命令的方式，Argcscript 使用 Argcfile.sh 来存储您的命令，称为“配方”。

为什么为您的项目选择 Argc？

• 利用 Bash 技能：无需学习新语言，非常适合 Bash 爱好者。
• GNU 工具集集成：利用熟悉的工具，如 awk、sed、grep、find 等。
• 环境变量管理：轻松加载、文档化和验证环境变量。
• 强大的 Shell 自动完成：享受自动完成建议，提高生产力。
• 跨平台兼容性：在 Linux、macOS、Windows 和 BSD 系统上无缝运行。

有关详细信息，请参阅 命令运行器。

完成

Argc 自动为所有基于 argc 的脚本提供 shell 完成功能。

argc --argc-completions <SHELL> [CMDS]...

以下，我们以cmd1和cmd2为例，说明如何为各种shell添加完成脚本。

# bash (~/.bashrc)
source <(argc --argc-completions bash cmd1 cmd2)

# elvish (~/.config/elvish/rc.elv)
eval (argc --argc-completions elvish cmd1 cmd2 | slurp)

# fish (~/.config/fish/config.fish)
argc --argc-completions fish cmd1 cmd2 | source

# nushell (~/.config/nushell/config.nu)
argc --argc-completions nushell cmd1 cmd2 # update config.nu manually according to output

# powershell ($PROFILE)
Set-PSReadlineKeyHandler -Key Tab -Function MenuComplete
argc --argc-completions powershell cmd1 cmd2 | Out-String | Invoke-Expression

# xonsh (~/.config/xonsh/rc.xsh)
exec($(argc --argc-completions xonsh cmd1 cmd2))

# zsh (~/.zshrc)
source <(argc --argc-completions zsh cmd1 cmd2)

# tcsh (~/.tcshrc)
eval `argc --argc-completions tcsh cmd1 cmd2`

所有完成脚本的核心都是调用argc --argc-compgen以获取完成候选。

$ argc --argc-compgen bash ./example.sh example --
--foo (Flag param)
--bar (Option param)
--baz (Option param (multi-occurs))
--help (Print help)
--version (Print version)

因此，argc也是一个完成引擎，请参见argc-completions中的1000多个示例。

手册页

为基于argc的CLI生成手册页。

argc --argc-mangen <SCRIPT> [OUTDIR]

argc --argc-mangen ./example.sh man/

man man/example.1

# Add .sh to PATHEXT
[Environment]::SetEnvironmentVariable("PATHEXT", [Environment]::GetEnvironmentVariable("PATHEXT", "Machine") + ";.SH", "Machine")

# Associate the .sh file extension with Git Bash
New-Item -Path Registry::HKEY_CLASSES_ROOT\.sh
New-ItemProperty -LiteralPath Registry::HKEY_CLASSES_ROOT\.sh -Name "(Default)" -Value "sh_auto_file" -PropertyType String -Force
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

许可证

版权所有（c）2023-2024 argc开发者。

argc根据您的选择，在MIT许可证或Apache许可证2.0的条款下提供。

有关许可证详细信息，请参阅LICENSE-APACHE和LICENSE-MIT文件。