Skip to main content

Commands and Flags

Runme executes commands inside your runbooks, documentation, and READMEs. It parses commands directly from Markdown files to make them executable.


Runme [command]: Specific commands or actions in Runme to perform different tasks.

Runme [flags]: Optional configurations to modify the behavior of our Runme runbook.

Runme Commands:

Below are some available commands within Runme

branchSuggest a branch name (aka branchGPT)
completionGenerate the autocompletion script for the specified shell
extensionCheck your Stateful VS Code extension status
fmtFormat a Markdown file into canonical format
helpHelp about any command
listList available commands
loginLog in to Runme (optional)
logoutLog out from Runme
openLaunch Runme in a headless web client
printPrint a selected snippet
runRun a selected command
suggestUse our suggestion engine to give contextual advice
tuiRun the interactive TUI

Runme Flags

Runme supported configuration flags.

--allow-unknownDisplay snippets without known executor (default true)
--allow-unnamedAllow scripts without explicit names
--backgroundEnable running background blocks as background processes
--chdir stringSwitch to a different working directory before executing the command (default "~/oss/")
--entries intNumber of entries to show in TUI (default 5)
--env-order stringArrayList of environment files to load in order. (default [.env.local,.env])
--exitExit TUI after running a command
--filename stringName of the README file (default "")
--filter stringRegular expression to filter results, by filename and task name
--git-ignoreWhether to respect .gitignore file(s) in project (default true)
-h, --helpHelp for Runme
--ignore-pattern stringArrayPatterns to ignore in project mode (default [node_modules])
--insecureRun command in insecure-mode
--load-envLoad env files from a local project. Control which files to load with --env-order (default true)
--project stringRoot project to find runnable tasks
-s, --server stringServer address to connect runner to
--tls stringDirectory for TLS authentication (default "~/Library/Application Support/runme/tls")
-v, --version-v, --version