Get Started
DocsTrack 5faq
/llms.txt
FAQ & Support5 min readbrevio-core v0.11.1

Frequently Asked Questions, Troubleshooting & Licensing

Plain-English Summary (For Anyone)

Clear answers about privacy, licensing, linters and CI

What brevio-core sends where, how it sits beside ESLint, Biome, Ruff and Semgrep, which licence it has, and how to fix the usual CI and hook problems.

Why this matters:
`scan`, the agent hook and the MCP server use no network and send nothing.
It works beside your existing linters and CI pipelines without replacing them.
`brevio-core init --undo` removes what init wrote and what you have not changed since.
When to use:Whenever you have questions about licensing, privacy, edge cases or configuration.
Technical Contract (For Engineers)
Line-level rules
CLI Invocation Signature:
brevio-core init --undo | brevio-core config [path]
Latency / Execution
Not measured for 0.11.1
Token Cost
No model call. No API key.
Exit Codes
0 = success; 1 = findings; 2 = usage error (including a broken brevio-core.toml)
Artifacts & Files Generated:
brevio-core.toml.brevio/baseline.json
Visual Execution Pipeline
5-Stage Progressive Flow
01Searchable
Ask
Find answers by topic or error message
02CLI diagnostics
Troubleshoot
Inspect the settings that apply with brevio-core config
03No lock-in
Roll back
Take back what init wrote with brevio-core init --undo

Privacy and Where Your Code Goes

In Plain English:Does brevio-core send my code anywhere? Not in `scan`, the agent hook or the MCP server.
`scan`, the agent hook and the MCP server use no network and send nothing. The rules make no model call and need no API key. `brevio-core ai` calls a model only when you connect one and answer yes: the optional `brevio-core ai` commands send a request to a model or program you connected, after you read the request and say yes. Nothing goes to Brevio. A program you connect receives the request on its standard input and may send it elsewhere, which brevio-core does not see. The Brevio Harness is a separate product that runs on your own server.

Coexistence with ESLint, Biome, Ruff, Semgrep and CodeQL

In Plain English:Do I need to throw away my linter? No. brevio-core sits beside it.
A linter checks style and correctness in the language it knows; Semgrep matches patterns you write; CodeQL follows data through a program. brevio-core is narrower: a fixed set of rules picked from mistakes coding agents repeat, run on the added lines, with the same output in the agent's loop as on the pull request. Several of its rules flag code that is valid to a linter. Keep your linter and add this for the agent mistakes.

Licensing: Apache-2.0 Core and the Commercial Harness

In Plain English:What are the rules around using brevio-core in a company?
`brevio-core` is licensed under Apache-2.0. The Brevio Harness is a separate commercial product for teams that want autonomous background operation on their own server; see the pricing page for its plans.

Common CI & Hook Issues and How to Fix Them

In Plain English:Quick solutions for the three most common setup questions.
1. **`scan --diff` exits 2 because the base is missing**: a shallow clone has no `origin/main`. Fetch it, or set `fetch-depth: 0` in your `actions/checkout` step so the base commit exists in the runner. 2. **A hook or scan is slow in a large monorepo**: add `exclude = ["vendor/**", "build/**"]` to `brevio-core.toml` to leave paths out. `brevio-core config <path>` shows what applies to a file or folder. 3. **Existing findings block the build**: run `brevio-core baseline` and commit `.brevio/baseline.json`; the default `fail-on: new` then fails only on new findings. 4. **A finding is wrong**: open a 'False positive' issue on the brevio-core repository with the line and why it is correct. Until it is fixed, a person can silence that one finding with `// brevio-core: ignore R9.2 -- reason`.

Interactive Rule Explorer

Explore the brevio-core rules and load their examples into the panel on the right.

129 / 129 rules