runner-cli 0.1.0

A cli tool that let's you map commands to a shorter alias
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# 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:
```toml
[Command]
alias = "ci"
program = "cargo"
args = "install --path ."

[Command]
alias = "nv"
program = "node"
args = "-v"

[Command]
alias = "cc"
program = "cargo"
args = "check"

```
### An example run for [ci] alias
### Output: 
![ci](images/ci.png)

## Installation
```
cargo install runner
```

## Initialize

### It will initialize a empty runner.toml file in config directory

```
runner --init
```
### Output:
![init](images/init.png)


## 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: 

![mapping](images/mapping.png)

## Options:

```
    -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


```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"
```