Document cli
This commit is contained in:
parent
d4aa300d28
commit
cc37b06d8b
1 changed files with 38 additions and 2 deletions
40
README.md
40
README.md
|
@ -24,6 +24,42 @@ $ cd some/nested/path
|
|||
$ rundir x build # runs the `build` script in the original `.run` directory
|
||||
```
|
||||
|
||||
## Why?
|
||||
## CLI
|
||||
|
||||
Cuz
|
||||
### List scripts
|
||||
|
||||
```shell
|
||||
$ rundir
|
||||
```
|
||||
|
||||
### Create script
|
||||
|
||||
```shell
|
||||
$ rundir create myscript
|
||||
```
|
||||
|
||||
### Run a script
|
||||
|
||||
```shell
|
||||
$ rundir x myscript
|
||||
|
||||
# ... or if you're in the root directory just...
|
||||
$ .run/myscript
|
||||
```
|
||||
|
||||
### Print the path of the current rundir
|
||||
|
||||
```shell
|
||||
$ rundir which
|
||||
```
|
||||
|
||||
### Open a script in your editor
|
||||
|
||||
```shell
|
||||
$ rundir edit myscript
|
||||
```
|
||||
|
||||
### Print help message
|
||||
```shell
|
||||
$ rundir help
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue