https://github.com/dotdot0/runner
A cli tool that let's you map commands to a shorter alias
https://github.com/dotdot0/runner
cli productivity rust
Last synced: about 2 months ago
JSON representation
A cli tool that let's you map commands to a shorter alias
- Host: GitHub
- URL: https://github.com/dotdot0/runner
- Owner: dotdot0
- Created: 2022-11-12T17:15:46.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-15T22:32:08.000Z (about 2 years ago)
- Last Synced: 2025-04-19T19:05:37.472Z (3 months ago)
- Topics: cli, productivity, rust
- Language: Rust
- Homepage: https://crates.io/crates/runner-cli
- Size: 2.27 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Runner
## 🤔 What is this?
A cli tool that let's you map commands to a shorter alias. Run the mapped command using the .
```
runner
```
You can map all your commands in runner.toml file
An example runner.toml file:
```toml
[Command]
alias = "ci"
program = "cargo"
args = ["install", "lsd"]
[Command]
alias = "nv"
program = "node"
args = ["-v"]
[Command]
alias = "cc"
program = "cargo"
args = ["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:
)
## 🔍 Find
#### Find a command mapped to the given alias
```
runner --find
```
### Output:
## Available
#### Check if a alias is available to use
```
runner --available
```
## 🖥️ Options:
```
-a, --add Map a new command to a alias right from terminal
--available Check if a alias is available to use
-c, --config Path of the the config file runner.toml
-f, --find Find a command mapped to the give alias
-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
```toml
[Command]
alias = "Shorter subcommand you want to use instead of the command"
program = "CLI Program Name(like: git, cat, batcat, code, neofetch, cargo, python, node, npm etc.)"
args = "Arguments you want to pass to the cli program"
```
## Contribution
#### Have any suggestion or feature idea/request feel free to open a issue.