Home - axnic/rtunk GitHub Wiki
rtunk
rtunk is a from-scratch, open-source rewrite of the trunk.io Code Quality CLI, for developers and teams who want one command to run their linters, formatters and security scanners.
It orchestrates existing tools behind a single declarative config, with per-project tool versions,
git-aware "only check what changed" runs, normalized output and caching. trunk itself is a
closed-source binary, which is hard to audit or get approved in a regulated environment; rtunk is
the same orchestration model as an auditable, 100% local tool.
[!IMPORTANT] This project is 100% vibe-coded: every line of code, commit and doc was written by an AI coding agent (Claude Code). The author's contribution is direction, architecture review and code review.
| rtunk is | rtunk is not |
|---|---|
Configuration-compatible with trunk (reads .trunk/trunk.yaml) |
A drop-in clone: deliberate differences exist |
| Open source and auditable | A closed binary |
| 100% local: no telemetry, no cloud account | A service with a daemon or a background process |
| Consumer of the trunk-io/plugins ecosystem | A reimplementation of linter definitions |
| Supported on macOS and Linux | Supported on Windows |
Getting started
For anyone installing rtunk or moving a trunk repository to it.
- Installation — release archive, mise, aqua,
go install, GitHub Action, dev container, supported platforms, upgrading - Quickstart — from an empty repository to your first
rtunk checkreport - Migrating from trunk — what carries over and what changes
Using rtunk
For everyday use, organized by what you are trying to do.
- Checking code — run linters, select files, apply fixes, read exit codes
- Formatting code — run formatters with
rtunk fmt - Ignoring issues — suppress findings with
rtunk-ignorecomments - Managing linters — list, enable and disable linters and inspect plugins
- Actions and git hooks — run actions and trigger them from git hooks
- Keeping tools up to date — maintain version pins with Renovate
- Cache and logs — manage downloaded tools and read past run logs
- GitHub Action — run rtunk in GitHub Actions with caching, annotations and a job summary
Reference
For looking up exact flags, keys and answers.
- Command Reference — every command and flag
- Configuration Reference — config schema and override precedence
- FAQ — short answers to common questions
Internals
For contributors: how rtunk is designed and why. These pages describe design, not usage.
- Architecture — package layout and responsibilities
- Plugin Model — how plugin definitions become runnable linters
- Plugin Sources — how plugin sources are resolved
- Cache Architecture — the content-addressed cache
- Run Flows — how a run executes end to end
- CLI Design — the command surface and run semantics
- Terminal UX Design — output rendering and the live view
- Decision Log — maintainers' recorded decisions
The project's source, license and contribution guide are in the repository; see also CONTRIBUTING.md.