runner-cli-0.1.1 is not a library.
Runner
π€ What is this?
A cli tool that let's you map commands to a shorter alias. Run the mapped command using the <ALIAS_NAME>. Inspired by npm scripts.
runner <ALIAS_NAME>
An example runner.toml file:
[]
= "ci"
= "cargo"
= "install --path ."
[]
= "nv"
= "node"
= "-v"
[]
= "cc"
= "cargo"
= "check"
An example run for [ci] alias
Output:
π¦ Installation
cargo install runner-cli
Initialize
It will initialize a empty runner.toml file in config directory
runner --init
Output:
βοΈ Config
Get the path to runner.toml file by running runner with config option
runner --config
πΊοΈ Mappings
Get all the user mapped alias
runner --mapping
Output:
β Add
Map a new command to an alias right from the terminal
runner --add
Output:
π₯οΈ Options:
-a, --add Map a new command to a alias right from terminal
-c, --config Path of the the config file runner.toml
-h, --help Print help information
-i, --init Initialize a empty runner.toml file
-m, --mapping Show all the user defined mappings
-V, --version Print version information
π TOML file guide:
Each command starts wtih a [Command] key
[]
= "Shorter subcommand you want to use instead of the command"
= "CLI Program Name(like: git, cat, batcat, code, neofetch, cargo, python, node, npm etc.)"
= "Arguments you want to pass to the cli program"