Documentation Index
Fetch the complete documentation index at: https://mintlify.com/ton-blockchain/acton/llms.txt
Use this file to discover all available pages before exploring further.
acton check runs the Tolk linter over the whole project, a specific contract
from Acton.toml, or a single .tolk file. In addition to plain human-readable
output, it supports machine-readable formats for CI pipelines, code-quality
dashboards, and IDE integrations. Auto-fix mode can apply safe rewrites in one
pass.
Synopsis
TARGET is either a contract name from Acton.toml or a path to a .tolk
file. When omitted, Acton checks all contracts, workspace test files, and
standalone script roots that define main().
Arguments & options
Check options
| Flag | Type | Default | Description |
|---|---|---|---|
[TARGET] | string | path | — | Contract name from Acton.toml or path to a .tolk file. Targets ending in .tolk are treated as file paths; other values are resolved as contract names. |
--fix | flag | false | Apply available auto-fixes. Works only in plain output mode. |
--output-format <FORMAT> | plain | json | sarif | github | gitlab | plain | Output format for diagnostics. Resolution order: CLI flag → [lint].output-format → plain. |
--output-file <PATH> | path | stdout | Write output to a file instead of standard output. Not valid with plain format. |
--enable-only <CODE[,CODE...]> | string | — | Enable only selected lint rules. Selected allow rules are re-enabled at their default severity; all other rules are forced to allow. Repeatable. |
--explain <CODE> | string | — | Print a human-readable explanation for a lint rule code. |
Global flags
| Flag | Type | Default | Description |
|---|---|---|---|
--color <WHEN> | auto | always | never | auto | Control coloured output. |
--manifest-path <PATH> | path | — | Path to Acton.toml. Conflicts with --project-root. |
--project-root <PATH> | path | — | Path to project root. Conflicts with --manifest-path. |
Output formats
- plain (default)
- json
- sarif
- github
- gitlab
Human-readable diagnostics with source context, compatible with
--fix.Behaviour notes
- Project-wide discovery includes workspace
*.test.tolkfiles and standalone script roots that definemain(). - Discovery skips
.git,.github,.idea,.acton,node_modules,target,tolk-stdlib,.codex, and.claude. - Contracts with non-
.tolksources (e.g. precompiled.bocentries) are not lint roots. - Single-file mode relaxes rule
E010 (acton-import-in-contract). - Inline suppressions use rule names:
- Compiler and parser diagnostics (
compiler-error,parse-error) cannot be suppressed withcheck-disable-next-line. --fixapplies only the first available fix per diagnostic and only for rules marked as auto-fixable. Unfixed diagnostics remain in the report and still contribute to the exit code.--enable-onlyselectors must resolve to exactly one rule — use full codes such asE002for stability.
Examples
CI recipe
.github/workflows/ci.yml