18 个版本
使用旧的 Rust 2015
| 0.8.11 | 2021 年 10 月 12 日 |
|---|---|
| 0.8.3 | 2018 年 8 月 29 日 |
| 0.8.1 | 2018 年 7 月 24 日 |
| 0.4.2 | 2018 年 3 月 30 日 |
#656 在 配置
80 个每月下载
51KB
1.5K SLoC
sdoc
一个围绕 shell 和可执行文件构建自定义 CLI 的框架。命令在 yaml 中定义，可以是子命令、shell 或可执行文件。按照惯例，你的根 yaml 文件位于与你的 CLI 名称相同的目录中，子命令配置在子目录中，遵循相同的模式。
安装
Homebrew
brew tap matthewwoodruff/sdoc https://github.com/matthewwoodruff/sdoc
brew install sdoc
Cargo
cargo install sdoc
手册
您可以从 GitHub 发布 下载二进制文件并将其添加到您的 $PATH
创建 CLI
- 为您的 CLI 创建一个新的目录
mkdir <cli-name> - 执行
sdoc init并按照提示操作 - 您的 CLI 将通过执行
./bin/<cli-name>而可用 - 修改
./<my-cli>/commands.yaml以添加自定义命令和子命令
示例
有关 CLI 配置的示例，请参阅 https://github.com/matthewwoodruff/sdoc/tree/master/tests/data/example-cli
Yaml 配置
命令
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| name | 字符串 | 是 | 命令名称 |
| description | 字符串 | 是 | 将在帮助中显示的描述 |
| type | type | 是 | 命令类型。下面提供选项。 |
| alias | 字符串 | 否 | 命令名称的简短版本 |
| usage | 字符串 | 否 | 在帮助中显示的用法文本 |
| dependencies | list<dependency> | 否 | 依赖项列表。下面提供选项。 |
| min_args | 整数 | 否 | 必须提供的最小参数数量 |
类型
| 选项 | 值 | 描述 |
|---|---|---|
| node | - | 子命令 |
| shell | 字符串 | 执行Shell代码 |
| 脚本 | 字符串 | 相对于命令文件的脚本文件 |
依赖项
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| 值 | 依赖类型 | 是 | 依赖类型。请见下文以了解选项。 |
| description | 字符串 | 是 | 在命令使用中显示对依赖项的说明 |
依赖类型
| 选项 | 值 | 描述 |
|---|---|---|
| 命令 | 字符串 | 必须存在于您的$PATH中的可执行文件 |
| 环境变量 | 字符串 | 必须设置的环境变量 |
依赖项
~1.9–2.8MB
~54K SLoC