Skip to content

main.command.init.readme.md

Latest commit

 

History

History
82 lines (56 loc) · 1.88 KB

main.command.init.readme.md

File metadata and controls

82 lines (56 loc) · 1.88 KB

main.command.init.readme

Command overview for init.

Purpose:

  • create .recur/config.toml from detected project lanes and separators
  • analyze an existing project (--analyze) and suggest config updates

Quick start

recur init

Creates:

  • .recur/config.toml with detected lanes (for example src/, docs/, julia-tests/)
  • .recur/checkpoints.md (if missing)
  • default [reveal] sections for lane-local *.recur.md ignition capsules
  • all default [traits.*] sections used by recur trait

Generated lane names are normalized to lowercase kebab-case section names. If two directories collapse to the same normalized lane name, recur init appends a numeric suffix so the generated TOML stays valid.

Example:

[test-quick]
dir = "test-quick/"
sep = "-"

[test-quick-2]
dir = "test_quick/"
sep = "."

Analyze mode

recur init --analyze
recur init --analyze --json

Reports:

  • detected lanes and their suggested separators
  • additions missing from config
  • separator updates for configured lanes
  • missing directories referenced by config

Overwrite behavior

recur init is safe by default. If .recur/config.toml already exists, it exits with code 2 and does not overwrite.

Use:

recur init --force

only when you intentionally want to regenerate config.

Why this matters

After recur init, commands that take -d can auto-resolve separator by directory from .recur/config.toml.

Example:

recur files "main_command_**" -d src/ --count

works without explicitly passing --sep _ when src/ is mapped to _ in config.

Testing

  • julia-tests/main.command.init.test.jl - command-level wrapper for init CLI coverage
  • julia-tests/runtests.init.jl - init command contract, analyze mode, and collision tests

Related

  • docs/main.command.config.readme.md
  • docs/main.command.init.lane-name-collision.complete.md