Practical guide5 min

Configuration basics

Pick config locations, generate templates, and choose what should or should not be committed to git.

Conflux uses JSONC for configuration, and the first goal is not maximal customization. The first goal is a config that makes runs predictable.

Supported config locations

Conflux looks for configuration in these places:

  • .cflx.jsonc
  • ~/.config/cflx/config.jsonc
  • --config <PATH>

The local project file is the best default when you want reproducibility per repository.

Generate a template

Terminal

cflx init cflx init --template opencode cflx init --template codex cflx init --force

For a first-run setup, plain cflx init is usually enough.

Minimal command wiring

A minimal Claude Code template looks like this:

{
  "analyze_command": "claude --dangerously-skip-permissions --verbose --output-format stream-json -p {prompt}",
  "apply_command": "claude --dangerously-skip-permissions --verbose --output-format stream-json -p '{prompt}'",
  "archive_command": "claude --dangerously-skip-permissions --verbose --output-format stream-json -p '{prompt}'",
  "acceptance_command": "claude --dangerously-skip-permissions --verbose --output-format stream-json -p '{prompt}'",
  "resolve_command": "claude --dangerously-skip-permissions --verbose --output-format stream-json -p {prompt}"
}

Adapt the commands to your actual agent CLI, but keep the role separation intact.

Commit or ignore?

Early on, make an explicit decision about these files:

  • ./.claude/skills/cflx-*
  • ./.cflx.jsonc

A useful rule of thumb:

ChoiceWhen it is reasonable
Commit bothYou want consistent team behavior across machines
Ignore bothThe setup is disposable and local-only

If you are unsure, committing both is often the easier default, as long as you avoid placing secrets directly in the config file.

Helpful defaults

  • Keep the first template close to generated defaults.
  • Avoid mixing local experiments into the config that the rest of the team depends on.
  • Prefer project-local config for repository-specific behavior.

Avoid this

Do not treat configuration as a place to hide every operational quirk. If a pattern becomes important enough to repeat, document it in your repo or convert it into a reusable skill.

Practical review checklist

Before you trust a config, verify these points:

  • the referenced agent CLI works outside Conflux,
  • the generated commands match the CLI actually installed on the machine,
  • the repository has a clear policy for committing or ignoring the generated setup files,
  • no credentials were accidentally placed inside .cflx.jsonc.

Related guides

All guides