Every command and flag the rtunk binary ships, with its arguments and defaults. Verified against rtunk help --all and each rtunk <command> --help of the current build. For the reasoning behind the CLI's shape and its run semantics, see CLI Design.

Every command also accepts -h/--help for this same information at the terminal. Commands that are groups (check, linters, actions, config, plugins, cache, git-hooks, logs, renovate, toolbox) show only their subcommand list: the check flags, for instance, are under rtunk check run --help.

These apply to every command below; they are not repeated in each command's own table.

Config-path and cache-directory precedence is detailed in Configuration Reference. A bare rtunk prints the help.

Run enabled checks against source files (read-only). rtunk check [<path>...] is shorthand for rtunk check run [<path>...]; the flags below belong to check run. Workflow and exit codes: Checking Code.

rtunk check [<path>...] [flags]

Arguments:

• <path>...: paths to check (default: changed files, see --from).

rtunk check --from origin/main

Run configured formatters against source files. Workflow: Formatting Code.

rtunk fmt [<path>...] [flags]

Arguments:

• <path>...: paths to format (default: changed files, see --from).

rtunk fmt --check

Run a specified action (shortcut for actions run; identical flags and behavior, see rtunk actions run).

rtunk run [<args>...] [flags]

Arguments:

• <args>...: <action-id> [-- args...] when --hook is not given; otherwise just the args to forward.

rtunk run <action-id>

Download enabled tools and runtimes into the local cache now. check, fmt and run otherwise download lazily. Items already installed are skipped; runtimes a tool needs are installed too.

rtunk download [<category> [<id>...]]

Arguments:

• <category>: one of runtime, tools or lint (a linter id, expanded to the linter's tools). Omit to download every enabled tool and runtime in use. With a category, ids resolve against the full catalog, so a just-enabled linter matching no file can be downloaded; an unknown id fails with download <category>: unknown id "<id>".
• <id>...: resource id(s), each optionally @version. At least one is required with a category; a category alone is an error.

Progress: on a terminal (stderr is a TTY, TERM not dumb) the same live install view as check and fmt (header Installing N% <bar> done/total · elapsed, one row per item downloading). Off a terminal, one installing <category>/<id> line per item on stderr. Then on stdout, Downloaded N item(s)., or Everything is already downloaded. when nothing was missing. Each failure prints ✖ <category>/<id>: <err> on stderr and the command exits non-zero with N of M download(s) failed.

rtunk toolbox download is the same command.

Only the global flags apply.

rtunk download
rtunk download lint shellcheck shfmt
rtunk download tools [email protected]

The resolved configuration and the plugin catalog behind it; see Managing Linters and Configuration Reference.

Print the fully resolved configuration.

rtunk config print [flags]

rtunk config print --output json

Print all configuration available across all plugins, resolved. Can be very large; useful as a registry dump. Replaces config print --all, which is removed.

rtunk plugins print [flags]

rtunk plugins print

Workflows: Managing Linters and Actions and Git Hooks.

List all linters available for the current configuration.

rtunk linters list [flags]

A linter enabled or re-pinned by a local override file shows (from <file>) after its file count (✔ vet 2 go files (from user.yaml)); one kept off by lint.disabled shows (disabled by <file>) (◯ mdlint 1 markdown file (disabled by rtunk.local.yaml)). In --format json, items gain enabled_by and disabled_by (file name, omitted when empty).

rtunk linters list --all

Enable one or more linters. With no id, opens a full-screen interactive checklist over the full catalog (the items linters list --all shows, in the same groups) and applies the selection.

rtunk linters enable [<id>...]

Arguments:

• <id>...: linter id(s) to enable, optionally @version. Omit for an interactive picker.

Unknown ids are rejected with an error and a non-zero exit; the configuration is left unchanged. Only the base config file is edited: an id listed in lint.disabled of a local override file stays off even once enabled here, and warning: <id> stays disabled: <file> lists it under lint.disabled is printed on stderr. The download hint below is still printed for such an id.

Afterwards prints Enabled: <ids> and/or Disabled: <ids> and, if anything was enabled, the hint rtunk download lint <ids>.

Picker keys: type to filter on id (backspace edits), up/down move, space toggles, enter confirms, esc or ctrl-c cancels (q is typed into the filter).

Only the global flags apply.

rtunk linters enable [email protected]

Disable one or more linters.

rtunk linters disable <id>...

Arguments:

• <id>...: linter id(s) to disable.

Only the base config file is edited. If a local override file still enables the id, stderr gets warning: <id> stays enabled: <file> enables it (remove it there, or list it under lint.disabled).

Only the global flags apply.

rtunk linters disable shellcheck

List actions available for the current configuration.

rtunk actions list [flags]

rtunk actions list

Enable one or more actions. With no id, opens the same full-screen interactive picker (keys as in linters enable).

rtunk actions enable [<id>...]

Arguments:

• <id>...: action id(s) to enable. Omit for an interactive picker.

Unknown ids are rejected with an error and a non-zero exit; the configuration is left unchanged.

Only the global flags apply.

rtunk actions enable <action-id>

Disable one or more actions.

rtunk actions disable <id>...

Arguments:

• <id>...: action id(s) to disable.

Only the global flags apply.

rtunk actions disable <action-id>

Run an action on demand, or every action a git hook triggers. rtunk run is a shortcut for this command.

rtunk actions run [<args>...] [flags]

Arguments:

• <args>...: <action-id> [-- args...] when --hook is not given; otherwise just the args to forward.

rtunk actions run <action-id>

Show recent action runs.

rtunk actions history [flags]

rtunk actions history --id <action-id> --limit 5

Install git hooks for enabled actions. Idempotent: re-running it rewrites the same hook files.

rtunk git-hooks sync [flags]

rtunk git-hooks sync

Remove rtunk-installed git hooks (what sync installed).

rtunk git-hooks unsync

Only the global flags apply.

rtunk git-hooks unsync

Initialize rtunk in this repository. Without .trunk/trunk.yaml, writes the .rtunk/rtunk.yaml scaffold (see Configuration Reference). With one, it migrates instead: .trunk/trunk.yaml moves to .rtunk/rtunk.yaml (content unchanged), as do configs/, user_trunk.yaml and user.yaml when present, printing migrated .trunk/<x> -> .rtunk/<y> for each; the rest of .trunk/ (trunk's links into ~/.cache/trunk, plugin checkouts, .gitignore) is then removed (removed .trunk/). trunk.yaml being tracked, git keeps the original.

Then prints initialized rtunk at <path>. On a terminal (stdin and stdout), it runs the linters picker, the actions picker (as in linters enable / actions enable, with the Enabled: / Disabled: summary but no download hint), then rtunk download of everything enabled with the live install view; a download failure is only a warning, check and fmt retry later. Off a terminal it prints next: rtunk linters enable, rtunk actions enable, rtunk download. Finally it links .rtunk/{logs,tools,plugins} and prints then: rtunk git-hooks sync to install the git hooks of the enabled actions. The generated .rtunk/.gitignore ignores logs, tools, plugins, user_trunk.yaml, user.yaml and rtunk.local.yaml (the local override files).

rtunk init [flags]

$ rtunk init
initialized rtunk at <repo>/.rtunk/rtunk.yaml
next: rtunk linters enable, rtunk actions enable, rtunk download
linked <repo>/.rtunk
then: rtunk git-hooks sync to install the git hooks of the enabled actions

Remove rtunk's configuration and installed artifacts.

rtunk deinit [flags]

rtunk deinit

Where the cache lives and what a run log contains: Cache and Logs.

Remove the rtunk cache: the downloads, plugins, logs and registry subtrees of the cache root, and nothing else in it. On a terminal, one line per existing subtree with a spinner that turns into a green ✔ <name> <size> freed (red ✖ with the error on failure); removals run in parallel and the result stays on screen. Off a terminal, removed <name> (<size>) per subtree. When none exists, prints The cache is already empty.

rtunk cache clean

Only the global flags apply.

rtunk cache clean

Remove cache entries no repository currently needs.

rtunk cache prune

Only the global flags apply.

rtunk cache prune

List this repository's recent runs.

rtunk logs list

Only the global flags apply.

rtunk logs list

Show one run's log (default: the latest).

rtunk logs show [<run>] [flags]

Arguments:

• <run>: run name (or a unique prefix of it) as printed by logs list, or latest.

rtunk logs show latest

Delete this repository's run logs.

rtunk logs clean [flags]

rtunk logs clean

Workflow: Keeping Tools Up To Date. Both enable and disable warn on stderr when no Renovate config file at the repository root contains the regexManager renovate config prints.

Annotate trunk.yaml's version pins for Renovate.

rtunk renovate enable

Only the global flags apply.

rtunk renovate enable

Remove the Renovate annotations from trunk.yaml.

rtunk renovate disable

Only the global flags apply.

rtunk renovate disable

Print the Renovate regexManagers config to add.

rtunk renovate config

Only the global flags apply.

rtunk renovate config

toolbox is callable but absent from the default rtunk --help; rtunk help --all lists it. The <category> argument of where and exec is runtime or tools. toolbox download is the public rtunk download.

Print a cached item's install directory (not its shim).

rtunk toolbox where <category> <id>

Arguments:

• <category>: resource category, one of runtime or tools.
• <id>: resource id, optionally @version.

Only the global flags apply.

rtunk toolbox where tools [email protected]

Run a command from a runtime or tool, downloading it first if missing. <cmd> is the item's shim when equal to <id>, else an executable in its install directory.

rtunk toolbox exec <category> <id> <args>... [flags]

Arguments:

• <category>: resource category, one of runtime or tools.
• <id>: resource id, optionally @version.
• <args>...: command to run, then its arguments.

rtunk toolbox x runtime [email protected] -- python3 --version

(Re)build .rtunk/logs, .rtunk/tools/<id> and .rtunk/plugins/<source-id> as symlinks into rtunk's cache, plus a .rtunk/.gitignore covering them and the local override files (user_trunk.yaml, user.yaml, rtunk.local.yaml); missing entries are appended to an existing .gitignore, existing lines are kept. The links give shells, editors and other tooling a fixed local path to the logs, the resolved tool shims and the plugin checkouts. A link may dangle until something populates its target; a local: plugin source is not linked. See Cache and Logs.

rtunk toolbox link

Only the global flags apply.

$ rtunk toolbox link
linked <repo>/.rtunk

• Checking Code and Formatting Code — the everyday workflow behind check and fmt
• Configuration Reference — the keys these commands read and write
• CLI Design — why the CLI is shaped this way, and its run semantics