\n\n> š Trunk is in beta. We'd appreciate your feedback - stop by the\n> [Trunk Community Slack](https://slack.trunk.io) and let us know what you think. Thanks!\n\nTrunk is a blazingly fast meta code checker and formatter with extraordinary features like caching,\npreexisting issue detection, a daemon, and a language server. It's managed completely via\nconfig-as-code, so you can easily pin your repo to specific versions of your linters, formatters,\nand static analyzers.\n\nDon't install a dozen different linter and formatting plugins, just use Trunk. Level up your code\nquality and consistency today.\n\n## Get Started\n\n1. Install Trunk ā `npm install @trunkio/launcher` ([docs](https://docs.trunk.io))\n1. Setup Trunk in your repo ā `npm exec trunk init` ([docs](https://docs.trunk.io))\n1. Take Trunk for a spin ā `npm exec trunk check --sample`\n\nThat's it!\n\n## Prereqs\n\nNone! Trunk manages linters and formatters for you via pinned versions in your repo's\n`.trunk/trunk.yaml` file. You don't need to install any linters or configure the extension in any\nway. We cache linters, formatters, and runtimes in `~/.cache/trunk`. Using a linter distributed as a\ngo module but you're not a go user? Don't worry about it, we handle it all š.\n\n## Linters / Formatters\n\nWe integrate new linters every release. Stop by on [slack](https://slack.trunk.io) and let us know\nwhat you'd like next!\n\n| Language | Linters |\n| --------------- | ----------------------------------------------------------------------------- |\n| All | `gitleaks` |\n| Ansible | `ansible-lint` |\n| Bash | `shellcheck`, `shfmt` |\n| Bazel, Starlark | `buildifier` |\n| C/C++ | `clang-format`, `clang-tidy` |\n| Cloudformation | `cfnlint` |\n| Docker | `hadolint` |\n| GitHub | `actionlint` |\n| Go | `gofmt`, `golangci-lint`, `semgrep` |\n| HAML | `haml-lint` |\n| Java | `semgrep` |\n| JS/TS | `eslint`, `prettier`, `semgrep` |\n| Kotlin | `detekt`, `detekt-explicit`, `ktlint` |\n| Markdown | `markdownlint` |\n| Protobuf | `buf-breaking`, `buf-lint` |\n| Python | `autopep8`, `bandit`, `black`, `flake8`, `isort`, `pylint`, `semgrep`, `yapf` |\n| Ruby | `brakeman`, `rubocop`, `rufo`, `semgrep`, `standardrb` |\n| Rust | `clippy`, `rustfmt` |\n| SQL | `sql-formatter` |\n| Terraform | `terraform`, `tflint` |\n| TOML | `taplo` |\n\n## Linting and formatting principles\n\n- Autoformat every file. _Every_ file.\n- Every file in your repo should have at least one tool checking its validity\n- You should always get the same results locally as on CI\n\n## Features\n\n### Configuration\n\nTrunk manages all configuration as code in your repo's `.trunk/trunk.yaml` file. When you first\n`trunk init`, we scan your repo for which linters and formatters are applicable to you and set up an\ninitial `.trunk/trunk.yaml` file for you to use. See the [docs](https://docs.trunk.io) for more\ndetails.\n\n### Formatting\n\n#### Don't install 15 formatters, just use trunk\n\nEver hit one of these problems?\n\n- Struggling to figure out why you need a Go or Ruby installation to run a specific formatter\n- Devs on your team all get slightly different formatting results because you're running different\n versions of the formatters\n- Your formatting doesn't match what your CI lint job is expecting because you're running a\n different version of a formatter locally\n\nThat's what formatting via Trunk solves. Everyone on your team is guaranteed to get the same\nresults, because we always run the same version of each formatter/linter on everyone's machine,\nincluding in your CI lint job.\n\n## Extras: VSCode Extension & GitHub Action\n\n1. Use a single extension for all your linting and formatting ā\n [Trunk VSCode Extension](https://marketplace.visualstudio.com/items?itemName=Trunk.io)\n1. Protect lint and format issues from leaking into main ā\n [Trunk GitHub Action](https://github.com/marketplace/actions/trunk-check)\n\n## How versioning works\n\nAfter you `trunk init`, `trunk.yaml` will contain a pinned version of Trunk to use for your repo.\nWhen you run trunk, it will automatically detect which version you should be running for a\nparticular repo and, if needed, download it, then run it. The trunk VSCode extension works the same\nway: regardless of what repo you're in, the underlying version of trunk it runs is based on the\npinned version in your `trunk.yaml` file. Config-as-code š.\n\nThis means that **everyone working in a repo, using the `trunk` cli, the VSCode extension, or when\nrunning on CI, all get the same results** because they're running the same version of trunk and the\nsame versions of all the linters/formatters. No more \"doesn't happen on my machine\". When you want\nto upgrade to a newer version, just run `trunk upgrade` and commit the updated `trunk.yaml`.\n\n## Development Status\n\nWe release new versions about every other week.\n\n## Feedback\n\nFor support and feedback, reach out on our [Trunk Community slack](https://slack.trunk.io). Thanks!\nā¤ļø\n","readmeFilename":"README.md"}
![](\"https://static.trunk.io/assets/vscode_icon.png\"){kind=icon}
\n \n![](\"https://img.shields.io/npm/dm/@trunkio/launcher.svg\")
\n ![](\"https://img.shields.io/visual-studio-marketplace/i/Trunk.io?logo=visualstudiocode\"/)
\n ![](\"https://img.shields.io/badge/slack-slack.trunk.io-blue?logo=slack\"/){kind=icon}
\n ![](\"https://img.shields.io/badge/docs.trunk.io-7f7fcc?label=docs&logo=readthedocs&labelColor=555555&logoColor=ffffff\"/){kind=icon}
\n