rundir/README.md
2024-11-13 15:55:59 -05:00

1 KiB

rundir

A CLI for managing .run script directories.

Concept

Make a .run directory in your project (or wherever) which houses relevant scripts as extensionless executable files. The rundir cli can help create and manage these scripts.

mkdir .run
rundir create build # Creates a template script at .run/build

When running a script, invoke them directly:

$ .run/build

If you are in a child directory of the root project folder where the .run directory lives, you can use rundir x:

$ cd some/nested/path
$ rundir x build # runs the `build` script in the original `.run` directory

CLI

List scripts

$ rundir

Create script

$ rundir create myscript

Run a script

$ rundir x myscript

# ... or if you're in the root directory just...
$ .run/myscript

Print the path of the current rundir

$ rundir which

Open a script in your editor

$ rundir edit myscript

Print help message

$ rundir help