docs: update references to consolidated CLI commands by carlos-alm · Pull Request #282 · optave/codegraph

carlos-alm · 2026-03-03T05:48:11Z

Summary

Update codegraph explain → codegraph audit --quick across all docs
Update codegraph hotspots → codegraph triage --level across all docs
Update codegraph manifesto → codegraph check across all docs
Add codegraph path references where query --path was used
Update remind-codegraph.sh hook example
MCP tool references left unchanged (backward compat)

Depends on #280 (CLI consolidation code changes).

Files changed

README.md
docs/examples/CLI.md
docs/guides/ai-agent-guide.md
docs/guides/recommended-practices.md
docs/use-cases/titan-paradigm.md
docs/examples/claude-code-hooks/remind-codegraph.sh

Test plan

Verify no stale codegraph explain, codegraph hotspots, or codegraph manifesto CLI references remain in docs
Verify MCP tool names (explain, hotspots, manifesto) are unchanged
Merge after refactor: consolidate CLI by removing 5 redundant commands #280

Update command references across all documentation: - `codegraph explain` → `codegraph audit --quick` - `codegraph hotspots` → `codegraph triage --level` - `codegraph manifesto` → `codegraph check` - Add `codegraph path` references - Update remind-codegraph.sh hook example MCP tool references are left unchanged (backward compat).

claude · 2026-03-03T05:48:23Z

Claude finished @carlos-alm's task —— View job

Reviewing PR: docs: update references to consolidated CLI commands

Todo List:

Read and analyze all changed files
Verify command mapping consistency
Check for missed CLI references
Validate MCP tool preservation
Assess dependency timing concerns
Provide structured review feedback

Root Cause Analysis

Problem Being Solved: This PR updates documentation to reflect CLI command consolidation changes from PR #280, where legacy commands (explain, hotspots, manifesto) are being replaced with new consolidated commands (audit --quick, triage --level, check).

Why This Approach: The approach is justified - CLI consolidation reduces command sprawl and creates more intuitive groupings. Documentation updates must follow the actual CLI changes to maintain consistency.

Risk Assessment: Low risk - this is purely a documentation update with no code changes. The changes are systematic and follow a clear mapping pattern.

Analysis Summary

✅ Positive Findings

Consistent command mappings across all files:
- codegraph explain → codegraph audit --quick ✓
- codegraph hotspots → codegraph triage --level ✓
- codegraph manifesto → codegraph check ✓
MCP tool names correctly preserved for backward compatibility:
- AI agent guide shows MCP tool: explain (unchanged) ✓
- CLI command shows codegraph audit --quick (updated) ✓
- This maintains API stability while updating CLI interface
Comprehensive coverage - all major documentation files updated:
- README.md: 26 additions, 20 deletions ✓
- CLI examples: 17 additions, 11 deletions ✓
- AI agent guide: 25 additions, 25 deletions ✓
- Hook script: properly updated reminder text ✓
Systematic approach - no missed references found in docs

⚠️ Minor Concerns

Dependency timing: This PR depends on refactor: consolidate CLI by removing 5 redundant commands #280 but could be merged before the CLI changes are actually implemented, potentially causing temporary documentation-code mismatch.
Hook script update: The remind-codegraph.sh now references audit --quick but will break if users have this PR without refactor: consolidate CLI by removing 5 redundant commands #280 merged.

✅ Additional Validation

Searched for any remaining stale CLI references - none found in docs
Verified MCP backward compatibility is maintained
Confirmed codegraph path additions where appropriate
No configuration changes that might hide underlying issues

Final Recommendation

Rating: ⭐⭐⭐⭐☆ (4/5)
Action: APPROVE with conditions
Reasoning: This is a well-executed documentation update that systematically reflects the CLI consolidation changes. The changes are consistent, comprehensive, and maintain backward compatibility where needed. The only concern is merge order dependency.

Conditions for approval:

Ensure PR refactor: consolidate CLI by removing 5 redundant commands #280 (CLI consolidation code changes) is merged first before this documentation update
Consider adding a note in the PR description about the merge order requirement

Overall Assessment: Clean, systematic documentation update that properly reflects the architectural consolidation. No evidence of shortcuts or workarounds that might indicate underlying problems.

greptile-apps · 2026-03-03T05:51:34Z

Greptile Summary

This PR successfully updates documentation to reflect the CLI consolidation from PR #280. All references to deprecated commands (explain, hotspots, manifesto, query --path) have been replaced with their new equivalents (audit --quick, triage --level, check, path). MCP tool names remain unchanged for backward compatibility.

Key changes:

codegraph explain → codegraph audit --quick across all docs
codegraph hotspots → codegraph triage --level file|directory with updated flag names (--metric → --sort)
codegraph manifesto → codegraph check (manifesto mode when run without ref or --staged)
codegraph query <a> --path  → codegraph path <a> 
Updated hook reminder in remind-codegraph.sh
Clarified that MCP tool names (explain, hotspots, manifesto) remain unchanged for backward compatibility

Stale references remain in:

docs/roadmap/ROADMAP.md (lines 236, 269, 1197)
docs/roadmap/llm-integration.md (line 123)
generated/dogfood/ and generated/competitive/ files (historical reports)

The roadmap files should be updated in a follow-up to maintain consistency, though the generated files are likely historical artifacts.

Confidence Score: 5/5

Safe to merge - documentation-only changes with consistent updates across all target files
All changed files correctly update CLI references to new consolidated commands. MCP backward compatibility is preserved as intended. Only issue is stale references in roadmap files not included in this PR.
Consider updating docs/roadmap/ROADMAP.md and docs/roadmap/llm-integration.md in a follow-up PR

Important Files Changed

Filename	Overview
CLAUDE.md	Updated CLI references: `explain` → `audit --quick`, `query --path` → `path`, `manifesto` → `check`
README.md	Comprehensive CLI command updates with expanded usage examples for `audit`, `triage`, and `check` commands
docs/examples/CLI.md	Updated section headers and examples: `explain` → `audit --quick`, `hotspots` → `triage --level`, `manifesto` → `check`
docs/guides/ai-agent-guide.md	Comprehensive CLI updates with clarification notes that MCP tool names remain unchanged for backward compatibility

_{Last reviewed commit: 20af81d}

greptile-apps

_{7 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2026-03-03T05:51:41Z

Additional Comments (1)

CLAUDE.md
CLAUDE.md contains stale CLI references that need updating:

Line 5: node src/cli.js explain <target> → node src/cli.js audit <target> --quick
Line 117: node src/cli.js explain <file-or-function> → node src/cli.js audit <file-or-function> --quick
Line 130: node src/cli.js query <a> --path -T → node src/cli.js path <a> -T
Line 135: node src/cli.js manifesto -T → node src/cli.js check -T
Line 136: Comment "Combined explain + impact" → "Combined structural summary + impact"

- explain → audit --quick - query --path → path - manifesto → check - "Combined explain + impact" → "Combined structural summary + impact"

claude · 2026-03-03T06:01:32Z

Claude finished @carlos-alm's task —— View job

Reviewing PR: docs: update references to consolidated CLI commands

Todo List:

Read and analyze all changed files
Verify command mapping consistency
Check for missed CLI references
Validate MCP tool preservation
Assess dependency timing concerns
Provide structured review feedback

Root Cause Analysis

Problem Being Solved: This PR updates documentation to reflect CLI command consolidation changes from PR #280, where legacy commands (explain, hotspots, manifesto) are being replaced with new consolidated commands (audit --quick, triage --level, check).

Why This Approach: The approach is justified - CLI consolidation reduces command sprawl and creates more intuitive groupings. Documentation updates must follow the actual CLI changes to maintain consistency.

Risk Assessment: Low risk - this is purely a documentation update with no code changes. The changes are systematic and follow a clear mapping pattern.

Analysis Summary

✅ Positive Findings

Consistent command mappings across all files:
- codegraph explain → codegraph audit --quick ✓
- codegraph hotspots → codegraph triage --level ✓
- codegraph manifesto → codegraph check ✓
MCP tool names correctly preserved for backward compatibility:
- AI agent guide shows MCP tool: explain (unchanged) ✓
- CLI command shows codegraph audit --quick (updated) ✓
- This maintains API stability while updating CLI interface
Comprehensive coverage - all major documentation files updated:
- README.md: 26 additions, 20 deletions ✓
- CLI examples: 17 additions, 11 deletions ✓
- AI agent guide: 25 additions, 25 deletions ✓
- Hook script: properly updated reminder text ✓
Systematic approach - no missed references found in docs
CLAUDE.md properly updated - addresses previous review feedback:
- Line 5: audit <target> --quick ✓
- Line 117: audit <file-or-function> --quick ✓
- Line 130: path <a> -T ✓
- Line 135: check -T ✓
- Line 136: comment updated to "Combined structural summary + impact" ✓

⚠️ Minor Concerns

Dependency timing: This PR depends on refactor: consolidate CLI by removing 5 redundant commands #280 but could be merged before the CLI changes are actually implemented, potentially causing temporary documentation-code mismatch.
Out-of-scope stale references: Found some stale CLI references in generated files (CHANGELOG.md, dogfood reports, roadmap files), but these are either auto-generated or historical and outside the scope of this documentation update.

✅ Additional Validation

Searched for any remaining stale CLI references in core docs - none found
Verified MCP backward compatibility is maintained throughout
Confirmed codegraph path additions where appropriate
No configuration changes that might hide underlying issues

Final Recommendation

Rating: ⭐⭐⭐⭐☆ (4/5)
Action: APPROVE with conditions
Reasoning: This is a well-executed documentation update that systematically reflects the CLI consolidation changes. The changes are consistent, comprehensive, and maintain backward compatibility where needed. Previous review feedback has been addressed by updating CLAUDE.md.

Conditions for approval:

Ensure PR refactor: consolidate CLI by removing 5 redundant commands #280 (CLI consolidation code changes) is merged first before this documentation update
Consider adding a note in the PR description about the merge order requirement

Overall Assessment: Clean, systematic documentation update that properly reflects the architectural consolidation. All critical files are updated, including the CLAUDE.md fixes identified in previous reviews. The stale references found in generated/historical files are outside the scope of this PR and don't detract from its quality.

carlos-alm · 2026-03-03T06:02:12Z

Fixed in 20af81d — updated all 5 stale CLAUDE.md references:

Line 5: explain <target> → audit <target> --quick
Line 117: explain <file-or-function> → audit <file-or-function> --quick
Line 130: query <a> --path  → path <a> 
Line 135: manifesto -T → check -T
Line 136: "Combined explain + impact" → "Combined structural summary + impact"

carlos-alm · 2026-03-03T06:02:19Z

@greptileai

Docs updates moved to separate PR #282.

greptile-apps bot reviewed Mar 3, 2026

View reviewed changes

docs: update CLAUDE.md stale CLI references

20af81d

- explain → audit --quick - query --path → path - manifesto → check - "Combined explain + impact" → "Combined structural summary + impact"

carlos-alm added a commit that referenced this pull request Mar 3, 2026

revert: remove docs changes from CLI consolidation PR

b7883ca

Docs updates moved to separate PR #282.

carlos-alm merged commit f3dd325 into main Mar 3, 2026
16 checks passed

carlos-alm deleted the docs/consolidate-cli-references branch March 3, 2026 06:18

github-actions bot locked and limited conversation to collaborators Mar 3, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update references to consolidated CLI commands#282

docs: update references to consolidated CLI commands#282
carlos-alm merged 2 commits intomainfrom
docs/consolidate-cli-references

carlos-alm commented Mar 3, 2026

Uh oh!

claude bot commented Mar 3, 2026 •

edited

Loading

Uh oh!

greptile-apps bot commented Mar 3, 2026 •

edited

Loading

Uh oh!

greptile-apps bot left a comment •

edited

Loading

Uh oh!

greptile-apps bot commented Mar 3, 2026

Uh oh!

claude bot commented Mar 3, 2026 •

edited

Loading

Uh oh!

carlos-alm commented Mar 3, 2026

Uh oh!

carlos-alm commented Mar 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

carlos-alm commented Mar 3, 2026

Summary

Files changed

Test plan

Uh oh!

claude bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewing PR: docs: update references to consolidated CLI commands

Root Cause Analysis

Analysis Summary

✅ Positive Findings

⚠️ Minor Concerns

✅ Additional Validation

Final Recommendation

Uh oh!

greptile-apps bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Uh oh!

greptile-apps bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot commented Mar 3, 2026

Uh oh!

claude bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewing PR: docs: update references to consolidated CLI commands

Root Cause Analysis

Analysis Summary

✅ Positive Findings

⚠️ Minor Concerns

✅ Additional Validation

Final Recommendation

Uh oh!

carlos-alm commented Mar 3, 2026

Uh oh!

carlos-alm commented Mar 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

claude bot commented Mar 3, 2026 •

edited

Loading

greptile-apps bot commented Mar 3, 2026 •

edited

Loading

greptile-apps bot left a comment •

edited

Loading

claude bot commented Mar 3, 2026 •

edited

Loading