Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matthewwoodruff/sdoc
Framework for building custom CLIs around shell, scripts, and executables
https://github.com/matthewwoodruff/sdoc
Last synced: about 1 month ago
JSON representation
Framework for building custom CLIs around shell, scripts, and executables
- Host: GitHub
- URL: https://github.com/matthewwoodruff/sdoc
- Owner: matthewwoodruff
- License: gpl-3.0
- Created: 2018-01-13T20:37:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-12T19:24:58.000Z (almost 3 years ago)
- Last Synced: 2024-04-25T15:45:11.963Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 312 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# sdoc
[](https://travis-ci.org/matthewwoodruff/sdoc) [](https://deps.rs/repo/github/matthewwoodruff/sdoc) [](https://crates.io/crates/sdoc)
A framework for building custom CLIs around shell and executables. Commands are defined in yaml and can be sub-commands, shell, or an executable. By convention your root yaml file lives in a directory named the same as your cli name and sub-command configuration in sub directories following the same pattern.
## Install
##### Homebrew
```
brew tap matthewwoodruff/sdoc https://github.com/matthewwoodruff/sdoc
brew install sdoc
```
##### Cargo
```
cargo install sdoc
```
##### Manual
You can download the binary from [GitHub Releases](https://github.com/matthewwoodruff/sdoc/releases) and add to your `$PATH`
## Create CLI
- Create a new directory for your CLI `mkdir `
- Execute `sdoc init` and follow the prompts
- Your CLI will be available by executing `./bin/`
- Modify `.//commands.yaml` to add custom commands and sub-commands
##### Example
see https://github.com/matthewwoodruff/sdoc/tree/master/tests/data/example-cli for an example cli configuration.
## Yaml Configuration
##### Command
| Field | Type | Required | Description
|:-------------|:-------------------|:-----------|:-----------
| name | string | yes | Command name
| description | string | yes | Description that will be show in help
| type | type | yes | Type of command. See below for options.
| alias | string | no | A shorter version of the command name
| usage | string | no | Usage text to be shown in help
| dependencies | list\ | no | List of dependencies. See below for options.
| min_args | int | no | Minimum amount of arguments to be supplied
##### Type
| Option | Value | Description
|:-------------|:--------|:-----------
| node | - | Sub-command
| shell | string | Shell code to execute
| script | string | A script file relative to the commands file
##### Dependencies
| Field | Type | Required | Description
|:-------------|:-------------------|:---------|:-----------
| value | dependency-type | yes | Dependency type. See below for options.
| description | string | yes | Shown against dependency in command usage
##### Dependency Type
| Option | Value | Description
|:-------------|:---------|:-----------
| command | string | An executable in your $PATH that must exist
| envar | string | An environment variable that must be set