Document cli

This commit is contained in:
Endeavorance 2024-11-13 15:55:59 -05:00
parent d4aa300d28
commit cc37b06d8b

View file

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