Skip to content

docs(cli): refresh cobra Short/Long for v0.4 (.bough.yaml + engine plugins)#18

Merged
ikeikeikeike merged 1 commit into
mainfrom
fix/cli-help-text-v04
Jun 18, 2026
Merged

docs(cli): refresh cobra Short/Long for v0.4 (.bough.yaml + engine plugins)#18
ikeikeikeike merged 1 commit into
mainfrom
fix/cli-help-text-v04

Conversation

@ikeikeikeike

Copy link
Copy Markdown
Member

Post-v0.4.0 follow-up: the cobra help strings still read like v0.3
(.worktree-isolation.yaml, "DB plugin"). README + CHANGELOG were
updated as part of #17 but the binary-embedded help text was missed.

Each Short/Long now points at the v0.4 canonical name (`.bough.yaml`
/ `.bough-ports.json` / `~/.bough/backups/`) with a one-clause "v0.3
... accepted on fallback" note. Runtime behaviour unchanged — only the
strings.

Test plan

  • `go build ./...` + `go run ./cmd/bough --help` renders the new
    strings.
  • `go test ./internal/cli/...`
  • `nix develop .#ci -c golangci-lint run ./...` clean
  • CI green

…ugins)

The cobra help strings still read like v0.3:

  bough --help                 → .worktree-isolation.yaml + "database engine"
  bough plugins --help         → "List DB plugins discoverable on PATH"
  bough config --help          → "Operations against the .worktree-isolation.yaml schema"
  bough config validate --help → ".worktree-isolation.yaml file"
  bough backfill --help        → .worktree-ports.json + ~/.claude/backups/
  bough list --help            → .worktree-ports.json

Each is updated to the v0.4 canonical name (.bough.yaml / .bough-ports.json /
~/.bough/backups/) with a one-clause "v0.3 ... accepted on fallback" note so
operators reading the help text know the deprecation window is still in
force. The Long description also broadens "database engine" → "engine"
and lists rabbitmq / kafka / NATS alongside the four bundled plugins.

Runtime behaviour unchanged — only the help text. go test ./internal/cli/...
+ golangci-lint clean locally.
@ikeikeikeike
ikeikeikeike merged commit 09fd0ea into main Jun 18, 2026
9 checks passed
ikeikeikeike added a commit that referenced this pull request Jun 19, 2026
Bundles the work shipped on main since v0.4.0:

  - cobra help text refresh (#18)
  - .env.local footer + backend error + doc-comment sweep (#19)
  - README/MIGRATION + plugins/db/CONTRACT.md drop + nix-default
    clarification (#20)
  - smoketool extraction + lifecycle.go/create.go phase split (bc05a88)
  - CI conformance matrix path fix (3f133c0)

No behaviour change; all docs / strings / refactor.
ikeikeikeike added a commit that referenced this pull request Jun 20, 2026
NewEventWriter now rejects relative paths up front with a clear
error pointing the caller at the monorepo root resolution path.
Two worktrees (or a CI step + a dev shell) used to race on a
cwd-relative .bough/memory/events.jsonl when one ran from the
monorepo root and the other from a worktree subdirectory.

docs/INSTINCTS.md gains an Audit log section documenting the
absolute-path contract and the default location.
ikeikeikeike added a commit that referenced this pull request Jun 20, 2026
…#15 + #17)

MEDIUM #15: coordinator.Query now consumes instinct.fallback_on_error.
On a primary backend error with the flag set and a fallback
backend wired in, the same QueryReq is replayed against the
fallback and a query_fallback audit event is emitted. v0.5 ships
only SQLite so callers pass nil for fallback (= no-op pass-through);
v0.6 wires mem0 + SQLite together and the flag starts mattering.

MEDIUM #17: sqlite.Import used to walk the YAML / JSONL payload
and increment counters without ever re-Storing the rows, so an
Import after Forget left the table empty. The new
parseExportedYAML / parseExportedJSONL helpers reconstruct
memapi.Instinct records and route each through the same Store
path the host uses for fresh ingest (UpsertSemantics=true). The
CLI reports imported / upserted / skipped so an operator can
confirm the round-trip.

LOW #18 follow-on: loadInstinctCoordinator anchors the default
.bough/memory/events.jsonl against the monorepo root the
loadConfigAndRoot helper resolves. Combined with the
NewEventWriter absolute-path requirement landed in the previous
commit, the CLI now writes to the same file regardless of cwd.

instinct.New takes a fourth parameter (fallback) — the package is
internal so callers outside the repo are not expected; v0.5.1
stays a drop-in upgrade for plugin authors and end users.
@ikeikeikeike
ikeikeikeike deleted the fix/cli-help-text-v04 branch June 28, 2026 12:40
ikeikeikeike added a commit that referenced this pull request Jul 4, 2026
fix: retrospective review fixes for merged PRs #9/#10/#11/#12/#18/#19/#20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant