Skip to content

BrokenCode reference

Configure BrokenCode

Configure BrokenCode globally or per project with JSON, JSONC, environment variables, and structured project directories.

UPDATED 03 Aug 20266 min readTECHNICAL GUIDE
01

Use JSON or JSONC with the published schema.

The schema powers validation and editor completion. JSONC comments and trailing commas are supported.

brokencode.json

{
  "$schema": "https://brokengpt.com/config.json",
  "autoupdate": true
}
02

Configuration layers merge from broad to specific.

  1. Remote organization defaults, when configured.
  2. User config at ~/.config/brokencode/brokencode.json.
  3. A custom path supplied through BROKENCODE_CONFIG.
  4. Project brokencode.json files from the repository root toward the current directory.
  5. .brokencode directories containing agents, commands, plugins, skills, tools, and themes.
03

Environment variables support automation and managed environments.

  • BROKENCODE_CONFIG points to an explicit config file.
  • BROKENCODE_CONFIG_DIR adds a custom configuration directory.
  • Keep credentials in the operating system keychain or environment rather than committing them.

Check your file

brokencode --config ./brokencode.json

STRAIGHT ANSWERS

Frequently asked questions

01Does BrokenCode support JSONC?

Yes. Comments and trailing commas are supported.

02Which config wins?

More specific layers loaded later override matching keys while other values remain merged.

Configure

Start with a small project file.

Add only the settings your repository needs and let the schema guide the rest.

Install BrokenCode