Flags

Flag reference

| Flag | Argument | Description | | --- | --- | --- | | --entry | <path> | Directory, file, or glob to check. Repeatable. Overrides the config's include when present. | | --ignore | <path> | Directory, file, or glob to exclude from the scan. Repeatable. | | --config | <path> | Path to a Kiira config file. Defaults to auto-discovery of kiira.config.*. | | --rule | <id>=<off\|warn\|error> | Set a rule level for this run. Repeatable. Beats every config layer. | | --reporter | <pretty\|json\|github> | Output format. Defaults to pretty. | | --fix | — | Rewrite mistagged fences, add group= tags, apply rule edits, and write framework overrides. | | --dry-run | — | With --fix, print a diff of what would change and write nothing. | | --verbose | — | Show full error messages and code frames (the pretty reporter is compact by default). | | --raw | — | Disable colored output; emit plain text. | | --static | — | Disable the loading spinner. | | -h, --help | — | Show help. | | -v, --version | — | Show the version. |

--entry <path>

Restricts the scan to specific directories, files, or globs. It is repeatable — pass it multiple times to check several locations:

kiira check --entry docs --entry README.md --entry "guides/**/*.mdx"

When any --entry is provided, it overrides the include globs in your config. Use it for quick, targeted runs (for example, checking only the file you just edited) without changing your config.

--ignore <path>

Excludes directories, files, or globs from the scan. Also repeatable:

kiira check --entry docs --ignore docs/api --ignore "**/*.generated.md"

This layers on top of the resolved entries, so you can include a whole folder and carve out a subfolder you don't want checked.

--config <path>

Points Kiira at a specific config file instead of auto-discovering one:

kiira check --config configs/kiira.config.mts

--rule <id>=<level>

Sets the level of a rule for one run, without editing your config. The level is off, warn, or error. It is repeatable, and both --rule id=level and --rule=id=level work:

kiira check --rule unused-symbols=warn --rule group=off

A --rule level wins over presets, rules, and per-glob overrides. A value that isn't <id>=<level> is an error, and so is an id Kiira doesn't know; both exit with code 2. Plugin rules use their full id, such as docs/no-todo.

--reporter <pretty|json|github>

Selects the output format. See the Reporters page for details on each one.

kiira check --reporter github

--fix

Applies safe automatic fixes — rewriting mistagged ts/typescript fences to tsx when JSX is detected, adding group= tags to ungrouped continuation snippets, and applying edits that rules return, and writing framework jsxImportSource overrides into your config. See the --fix page.

kiira check --fix

--dry-run

Only valid with --fix; on its own it exits with code 2. Prints a unified diff for every file --fix would change and writes nothing, including your config. The exit code is the one the check itself produced, as if nothing had been fixed. With --reporter json the diff goes to stderr so stdout stays valid JSON.

kiira check --fix --dry-run

--verbose

The pretty reporter is compact by default. Add --verbose to print full error messages and code frames:

kiira check --verbose

--raw

Disables ANSI colors so output is plain text — useful when piping to a file or a log that doesn't render colors:

kiira check --raw

--static

Disables the animated loading spinner. Handy in CI logs or non-TTY environments where spinner frames add noise:

kiira check --static

-h, --help and -v, --version

kiira --help
kiira --version