Skip to content

Configuration reference ​

All settings live in .fixlock/config.json. init writes it; you can edit it by hand. Locks live in .fixlock/registry.json. Don't edit that by hand; use the commands.

json
{
  "project": "Fluxo ERP",
  "team": [
    { "name": "Abi", "github": "abinandhmj", "emails": ["abi@fluxo.dev"], "role": "lead" },
    { "name": "Ravi", "github": "ravik", "emails": ["ravi@fluxo.dev"], "role": "developer" }
  ],
  "policies": {
    "bug":     { "onEdit": "ask",  "approval": "owner" },
    "feature": { "onEdit": "warn", "approval": "owner-or-lead" }
  },
  "aiTools": ["claude-code", "codex", "cursor"],
  "stableCode": { "enabled": true, "onEdit": "ask", "olderThanDays": 7, "minLines": 3 },
  "autoLock": { "enabled": true, "lockFeatures": true, "maxLines": 40 },
  "tracker": { "type": "linear", "onFix": "Done", "onRegression": "In Progress" },
  "protectedPaths": [],
  "changelog": true,
  "ignoreTrivialLines": true,
  "matching": { "mode": "structural", "renames": "warn" }
}

team ​

FieldMeaning
nameDisplay name
githubGitHub username, used for PR approvals and CODEOWNERS
emailsGit commit emails, used to recognise who is editing or committing
rolelead, developer or reviewer

policies.bug / policies.feature ​

FieldValues
onEditwarn, ask, block (what happens before an AI edit)
approvalowner, lead, owner-or-lead, none (who must approve the PR)

aiTools ​

Tool ids to write rules files for: claude-code, codex, cursor, copilot, windsurf, gemini, cline, roo, continue, aider, amazonq, junie. Manage with npx fixlock tools add|remove.

stableCode (working-code guard) ​

FieldDefaultMeaning
enabledtrueTurn the guard on or off
onEditaskwarn, ask or block for AI edits that rewrite working code
olderThanDays7Your own committed code counts as "working" after this many days
minLines3Ignore edits that rewrite fewer lines than this

autoLock ​

FieldDefaultMeaning
enabledtrueLock lines from fix/feature commits
lockFeaturestrueAlso lock feat: commits
maxLines40Skip blocks bigger than this
bugPatternconventional fix:/bugfix:/hotfix: + words fix/fixed/bug/hotfix/issueRegex for bug-fix commit messages
featurePattern^feat(\(.+\))?!?:Regex for feature commit messages
ignorelock files, .md, .json, images, .fixlock/Files never auto-locked

launcher ​

How hooks, MCP configs and AI rules start fixlock. Unset (the default): the project's installed npm package, or npx -y @abinandhmj/fixlock@<version>. "fixlock": the native fixlock command (installed with pipx install fixlock, uv tool install fixlock or pip install fixlock). fixlock init sets it when you run it from the native command. Every developer then needs fixlock on their PATH. Set FIXLOCK_LAUNCHER to override it on one machine.

matching ​

How locks are compared with the current code.

FieldDefaultMeaning
modestructuralstructural compares tokens, so formatting, comments, quote style, semicolons, trailing commas and line wrapping are ignored. Used for JS/TS, Python, Java, Go, C#, Kotlin, Rust, C/C++, Swift, PHP, Ruby and similar; other files fall back to text. text compares lines of text (whitespace-insensitive), as before v0.6.
renameswarnWhat a consistent rename of variables inside a lock means: allow (ignore it), warn (report, don't block), ask / block (treat it like a change: the AI asks first and the PR needs approval). Renaming a field or object key is always a change.

tracker ​

See Issue trackers. Tokens are never stored here.

Other ​

FieldMeaning
protectedPathsPath prefixes, e.g. ["src/app/core/"]; any change there is reported (warning only)
changelogfalse to stop updating CHANGELOG.md
ignoreTrivialLinesIgnore blank and brace-only lines

Environment variables ​

VariableUsed for
GITHUB_TOKEN / GH_TOKENReading PR approvals in CI
LINEAR_API_KEY, CLICKUP_TOKEN, NOTION_TOKENTracker sync
FIXLOCK_WEBHOOK_URL, FIXLOCK_WEBHOOK_SECRETWebhook tracker
FIXLOCK_BASEDefault --base for check
FIXLOCK_USEROverride who you are (email or GitHub username)
NO_COLORPlain output

MIT licensed · A product of Algotricz