Repository navigation
Documented init --dir in the CLI reference - #56
Conversation
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation accurately matches the implemented CLI behavior and validation.
Review effort: Balanced
Findings: None
What changed in this PR
Documents the existing intelligence init --dir behavior without changing runtime code.
Changes:
- Clarifies the option’s purpose, manifest field, path restrictions, and new-project scope.
| File | Description |
|---|---|
docs/cli.md |
Adds the missing --dir name reference documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Verification - PASShead: b9f251b - steps: sha256:478c1c66 (## Verification section, 3 steps; docs/cli.md matched no qa_checks glob — none declared in profile/docs/qa-checks.md) - env: local (runtime archived from head into a scratch dir per the PR's own instructions:
No qa_checks entry matched: FailuresNone. |
Code review - CLEANhead: b9f251b - base: main - files 1, +1/-1 CriticalNone. WarningNone. SuggestionNone. |
Summary
docs/cli.mdlistedinit [--dir name]in the synopsis and never said what it does, so a reader — a verification stage on #50 included — guessed it named an output or target directory. It names the project's content directory: where its own rules, agents, skills and adapters live, recorded asproject.intelligence_dir, a plain directory inside the repository, accepted only when creating a new project (cli/commands/init.sh). One sentence in theinitsection now says exactly that. No behavior changes.Type of change
Public CLI check
intelligence sync(unchanged)Verification
Work in a scratch directory outside this checkout; nothing below moves the checkout or its refs. Lay out this branch's runtime first:
mkdir rt && git -C <checkout> archive <this PR's head> cli engine packages | tar -x -C rt, and usebash rt/cli/intelligenceas the CLI.intelligence initsection ofdocs/cli.mdat this PR's head. Expected: a sentence explains--dir nameas the content directory, recorded asproject.intelligence_dir, a plain in-repo directory, new projects only.git init aand runinit --dir ai --no-syncina. Expected: exit 0;a/intelligence.yamlhasintelligence_dir: "ai"underproject:and its project sources readai/rules,ai/agents,ai/skills.git init b, runinit --dir ../outside. Expected: non-zero exit naming a plain directory inside the repo. Then runinit --dir otherina(already a project). Expected: non-zero exit saying--dir applies only when creating a new project.Automated coverage
None needed: no executable line changes. CI runs the full suites on this head.
Versioned artifacts
CHANGELOG.mdchangeNotes for reviewers
Found by the verification stage on #50; fixed here so it does not outlive the 0.19.0 release.