Using the CLI

Feeling like Runme is great, but you want something even more powerful? Well, lucky for you, there is a Runme CLI!

The Runme CLI is ideal for power-users who want to get the absolute most out of Runme.

Installing

See the doc page on the cli for installation instructions.

Runme has a nice TUI that you can use simply like so:

Runme won't work if your current working directory doesn't contain a README file at top-level!

You can use the --chdir flag to alter this behavior, without changing the environment's working directory.

(TODO: better gif)

This allows you to quickly execute any script present in the README.

The TUI is nice, but what if you just want to run a specific command quickly?

To run a specific script by name, use the runme run <command> subcommand!