codespeak.json

โš ๏ธ CodeSpeak is in Alpha Preview: many things are rough around the edges. Please use at your own risk and report any issues to our Discord. Thank you!

The configuration file created by codespeak init controls how CodeSpeak operates.

specs

An array of paths to spec files, relative to the project root:

{
  "specs": [
    "src/converters/eml_converter.cs.md",
    "src/reports/line_report.spec.md"
  ]
}

whitelisted_files

Files that CodeSpeak is allowed to modify but doesn't own:

{
  "whitelisted_files": [
    "src/converters/__init__.py",
    "src/app/_registry.py"
  ]
}

Supports glob patterns:

{
  "whitelisted_files": [
    "src/**/__init__.py"
  ]
}

See Managed files for more on how CodeSpeak tracks file ownership.

Other settings

SettingTypeDescription
strictManagedFilesControlbooleanPrevents CodeSpeak from writing to non-managed files
suppressNonManagedFilesNotificationbooleanHides the non-managed files notification

See also