- author: "Matthias Morin" mat@tangoman.io
- version: 0.12.0-xl
- link: https://github.com/TangoMan75/shoe
Create self documented shell scripts with argument validation easily. Prefix a comment with two pound signs on the previous line of any function or variable you want documented with the "help" command. Features: - [X] colors - [X] commands - [X] help - [X] docbloc - [X] parameters - [X] validation - [X] flags - [X] install - [X] autocomplete - [X] generate_doc Warning: Functions and variables names should not contain dashes.
sh shoe-xl.sh [command] (--who "World") (--count 1) (--env "dev") (--flag) (--global)
- ALIAS
- Script alias
- Value: shoe
- VERSION
- Constants are ignored (must be uppercase)
- Value: 0.12.0-xl
- --flag
- Enable FooBar mode
- --global
- Install script globally
- --who
- Description: Who do you want to say "hello" to ?
- Constraint: /^[a-zA-Z-]+$/
- Default: "World"
- --count
- Description: How many times to say hello
- Constraint: /^[1-9]$/
- Default: 1
- --env
- Description: Environment
- Constraint: /^(prod|dev|test)$/
- Default: "dev"
- hello
- Say hello to arbitrary recipient
- generate_doc
- Generate Markdown documentation
- self_install
- Install script and enable completion
- self_uninstall
- Uninstall script from system
- self_update
- Update script from @update-link
- help
- Print this help (default)