clias

Turn shell script into CLIs

Installation

Install this tool using pip:

pip install clias

Usage

For help, run:

Usage: clias [OPTIONS] COMMAND [ARGS]...

  Turn shell script into cli command

Options:
  -d, --dryrun  dry run mode, only show the rendered command
  --version     Show the version and exit.
  --help        Show this message and exit.

Commands:
  info  Show the clias config file path to be loaded

You can also use:

python -m clias --help

Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

cd clias
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

make install-e

To run the tests:

make test

To run pre-commit to lint and format:

make check

make check detects if cli help message in README.md is outdated and updates it.

To update cli help message README.md:

make readme

this runs cog on README.md and updates the help message inside it.