Kiira
ChevronDown
Github

Reporters

Reference for Kiira's output reporters — pretty (the default human-readable output), json (machine-readable), and github (GitHub Actions annotations).

Choosing a reporter

Use --reporter to control output format:

kiira check --reporter pretty default
kiira check --reporter json
kiira check --reporter github

pretty (default)

Human-readable terminal output. By default it's compact — it shows which files and fences failed without flooding your terminal. Add --verbose to expand each diagnostic with the full error message and a code frame pointing at the offending line:

kiira check
kiira check --verbose

Pair with --raw to drop ANSI colors and --static to drop the spinner when you're capturing logs:

kiira check --raw --static

json

Emits a machine-readable JSON document describing every diagnostic — the file, the line in the Markdown, and the message. Use this when you want to post-process results or feed them into your own tooling:

kiira check --reporter json
# Example: pipe results into a file for later processing
kiira check --reporter json > kiira-report.json

github

Emits GitHub Actions workflow commands so failures appear as inline annotations on the changed lines in a pull request. Use this in any GitHub Actions workflow:

kiira check --reporter github

When you use the official Kiira GitHub Action, github is already the default reporter, so annotations work out of the box.