dev
307d2fd471
Adds the project-review workflow for code review independent of the git diff. The scope is parsed from the user instruction: 全面/整个项目 -> whole-project (score every source file), otherwise feature + target keyword (locate the code with semantic search + graph queries). - scoring_tools.py: score_review_func gains all_files=True to score every source file in the graph via store.get_all_files() - main.py: score_review_tool gains all_files param; registers the project_review MCP prompt (prompts 6->7) - prompts.py: project_review_prompt(scope, target) with whole-project and feature branches (fixed a precedence bug that truncated the feature text) - skills.py + skills/project-review/: new read-only project-review skill with shared checklists - .opencode/command/code-review-graph-project-review.md: slash command - tests: test_project_review.py (prompt rendering), TestProjectReviewPrompt, skill count assertions 5->6, all_files wiring checks - docs: prompts (6->7) + project-review entries across COMMANDS, CLAUDE, README (+localized), INDEX, architecture, LLM-OPTIMIZED-REFERENCE, CHANGELOG
485 lines
16 KiB
Markdown
485 lines
16 KiB
Markdown
# All Available Commands
|
|
|
|
## Skills and Slash Commands
|
|
|
|
These commands are installed for clients that support project skills or slash-command style workflows.
|
|
|
|
### `/code-review-graph:build-graph`
|
|
Build or update the knowledge graph.
|
|
- First time: performs a full build
|
|
- Subsequent: incremental update (only changed files)
|
|
|
|
### `/code-review-graph:review-delta`
|
|
Review only changes since last commit.
|
|
- Auto-detects changed files via git diff
|
|
- Computes blast radius (2-hop default)
|
|
- Generates structured review with guidance
|
|
|
|
### `/code-review-graph:review-pr`
|
|
Review a PR or branch diff.
|
|
- Uses main/master as base
|
|
- Full impact analysis across all PR commits
|
|
- Structured output with risk assessment
|
|
|
|
### `/code-review-graph:unified-review`
|
|
Three-layer unified code review (CRG graph context + ai-code-review scoring + gstack-review workflow).
|
|
- Read-only: every finding waits for a manual fix decision
|
|
- Objective Layer-2 metrics via `score_review_tool`
|
|
- Fingerprint merge + quality score via `dedupe_findings_tool`
|
|
- Standalone HTML report via `generate_report_tool`
|
|
|
|
### `/code-review-graph:project-review`
|
|
Whole-project or single-feature code review (not diff-based).
|
|
- Scope parsed from user instruction: 全面/整个项目 → whole-project; otherwise feature + target
|
|
- Whole-project: `score_review_tool(all_files=True)` scores every source file
|
|
- Feature: `semantic_search_nodes` + `query_graph(children_of)` locate the code
|
|
- Read-only: every finding waits for a manual fix decision
|
|
|
|
## MCP Tools
|
|
|
|
### Core Tools
|
|
|
|
#### `build_or_update_graph_tool`
|
|
```
|
|
full_rebuild: bool = False # True for full re-parse
|
|
repo_root: str | None # Auto-detected
|
|
base: str | None = None # Diff base; None auto-resolves to the last-synced commit
|
|
postprocess: str = "full" # "full", "minimal", or "none"
|
|
recurse_submodules: bool | None # Falls back to CRG_RECURSE_SUBMODULES
|
|
```
|
|
|
|
#### `run_postprocess_tool`
|
|
```
|
|
flows: bool = True
|
|
communities: bool = True
|
|
fts: bool = True
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_minimal_context_tool`
|
|
```
|
|
task: str = "" # What you are doing
|
|
changed_files: list[str] | None # Auto-detected from VCS when omitted
|
|
repo_root: str | None
|
|
base: str = "HEAD~1"
|
|
```
|
|
|
|
#### `get_impact_radius_tool`
|
|
```
|
|
changed_files: list[str] | None # Auto-detected from VCS
|
|
max_depth: int = 2 # Hops in graph
|
|
repo_root: str | None
|
|
base: str = "HEAD~1"
|
|
detail_level: str = "standard" # "standard" or "minimal"
|
|
```
|
|
Relevant responses may include compact estimated `context_savings` metadata.
|
|
|
|
#### `query_graph_tool`
|
|
```
|
|
pattern: str # callers_of, references_to, callees_of, imports_of, importers_of,
|
|
# children_of, tests_for, inheritors_of, file_summary
|
|
target: str # Node name, qualified name, or file path
|
|
repo_root: str | None
|
|
detail_level: str = "standard" # "standard" or "minimal"
|
|
```
|
|
|
|
#### `get_review_context_tool`
|
|
```
|
|
changed_files: list[str] | None
|
|
max_depth: int = 2
|
|
include_source: bool = True
|
|
max_lines_per_file: int = 200
|
|
repo_root: str | None
|
|
base: str = "HEAD~1"
|
|
detail_level: str = "standard" # "standard" or "minimal"
|
|
```
|
|
Relevant responses may include compact estimated `context_savings` metadata.
|
|
|
|
#### `traverse_graph_tool`
|
|
```
|
|
query: str
|
|
depth: int = 3 # 1-6
|
|
mode: str = "bfs" # "bfs" or "dfs"
|
|
token_budget: int = 2000
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `semantic_search_nodes_tool`
|
|
```
|
|
query: str # Search string
|
|
kind: str | None # File, Class, Function, Type, Test
|
|
limit: int = 20
|
|
repo_root: str | None
|
|
model: str | None # Embedding model (falls back to provider-specific env vars)
|
|
provider: str | None # local, openai, google, minimax, voyage
|
|
detail_level: str = "standard"
|
|
```
|
|
|
|
#### `embed_graph_tool`
|
|
```
|
|
repo_root: str | None
|
|
model: str | None # Embedding model name
|
|
provider: str | None # local, openai, google, minimax, voyage
|
|
```
|
|
Local embeddings require: `pip install "code-review-graph[embeddings]"`. Cloud providers use stdlib HTTP clients and require their provider environment variables.
|
|
|
|
#### `list_graph_stats_tool`
|
|
```
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `find_large_functions_tool`
|
|
```
|
|
min_lines: int = 50 # Minimum line count threshold
|
|
kind: str | None # File, Class, Function, or Test
|
|
file_path_pattern: str | None # Filter by file path substring
|
|
limit: int = 50 # Max results to return
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_docs_section_tool`
|
|
```
|
|
section_name: str # usage, review-delta, review-pr, commands, legal, watch, embeddings, languages, troubleshooting
|
|
```
|
|
|
|
### Flow Tools
|
|
|
|
#### `list_flows_tool`
|
|
```
|
|
sort_by: str = "criticality" # criticality, depth, node_count, file_count, name
|
|
limit: int = 50
|
|
kind: str | None # Filter by entry point kind (e.g. "Test", "Function")
|
|
repo_root: str | None
|
|
detail_level: str = "standard"
|
|
```
|
|
|
|
#### `get_flow_tool`
|
|
```
|
|
flow_id: int | None # Database ID from list_flows_tool
|
|
flow_name: str | None # Name to search (partial match)
|
|
include_source: bool = False # Include source snippets for each step
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_affected_flows_tool`
|
|
```
|
|
changed_files: list[str] | None # Auto-detected from VCS
|
|
base: str = "HEAD~1"
|
|
repo_root: str | None
|
|
```
|
|
|
|
### Community Tools
|
|
|
|
#### `list_communities_tool`
|
|
```
|
|
sort_by: str = "size" # size, cohesion, name
|
|
min_size: int = 0
|
|
repo_root: str | None
|
|
detail_level: str = "standard"
|
|
```
|
|
|
|
#### `get_community_tool`
|
|
```
|
|
community_name: str | None # Name to search (partial match)
|
|
community_id: int | None # Database ID
|
|
include_members: bool = False
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_architecture_overview_tool`
|
|
```
|
|
repo_root: str | None
|
|
detail_level: str = "minimal" # "minimal" compact default, "standard" full detail
|
|
```
|
|
Minimal responses may include compact estimated `context_savings` metadata.
|
|
|
|
### Graph Health and Architecture Tools
|
|
|
|
#### `get_hub_nodes_tool`
|
|
```
|
|
top_n: int = 10
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_bridge_nodes_tool`
|
|
```
|
|
top_n: int = 10
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_knowledge_gaps_tool`
|
|
```
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_surprising_connections_tool`
|
|
```
|
|
top_n: int = 15
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `get_suggested_questions_tool`
|
|
```
|
|
repo_root: str | None
|
|
```
|
|
|
|
### Change Analysis and Refactoring Tools
|
|
|
|
#### `detect_changes_tool`
|
|
```
|
|
base: str = "HEAD~1"
|
|
changed_files: list[str] | None
|
|
include_source: bool = False
|
|
max_depth: int = 2
|
|
repo_root: str | None
|
|
detail_level: str = "standard"
|
|
```
|
|
Primary tool for code review. Maps changed files to affected functions, flows, communities, and test coverage gaps. Returns risk scores and prioritized review items.
|
|
Relevant responses may include compact estimated `context_savings` metadata.
|
|
|
|
### Unified Review Tools
|
|
|
|
#### `score_review_tool`
|
|
```
|
|
changed_files: list[str] | None # Auto-detected from git diff if omitted
|
|
base: str = "HEAD~1"
|
|
include_churn: bool = True
|
|
repo_root: str | None
|
|
detail_level: str = "standard" # "minimal" for grades + values only
|
|
```
|
|
Computes objective Layer-2 metrics for changed files: `sql_risk`,
|
|
`exception_coverage`, `redundancy_rate`, `high_risk_density`,
|
|
`vulnerability_risk`. Each metric carries a `good`/`warn`/`fail` grade,
|
|
thresholds and evidence. LLM-judged metrics are listed in `llm_judged`.
|
|
|
|
#### `dedupe_findings_tool`
|
|
```
|
|
findings: list # [{path, category, severity, confidence, source?}]
|
|
suppress_prior: list | None # Previously user-skipped findings to suppress
|
|
repo_root: str | None
|
|
```
|
|
Merges findings by `path:line:category` fingerprint (highest confidence
|
|
wins), boosts multi-source confidence (+1, cap 10), routes low-confidence
|
|
findings to the appendix, and computes `PR quality score = max(0, 10 -
|
|
(critical*2 + informational*0.5))`.
|
|
|
|
#### `generate_report_tool`
|
|
```
|
|
review_data: dict # metrics + findings + verdict + tier + scope
|
|
output_path: str | None # Base name without extension
|
|
repo_root: str | None # Default: <repo_root>/code-review-report
|
|
format: str = "both" # "html" | "markdown" | "both"
|
|
```
|
|
Renders the standalone HTML review report (self-contained, no external
|
|
dependencies) and/or the Chinese Markdown report from the bundled
|
|
`report-template.html`. Default `format="both"` writes
|
|
`code-review-report.html` + `code-review-report.md`.
|
|
|
|
#### `refactor_tool`
|
|
```
|
|
mode: str = "rename" # "rename", "dead_code", or "suggest"
|
|
old_name: str | None # (rename) Current symbol name
|
|
new_name: str | None # (rename) New name
|
|
kind: str | None # (dead_code) Function or Class
|
|
file_pattern: str | None # (dead_code) Filter by file path substring
|
|
repo_root: str | None
|
|
```
|
|
|
|
#### `apply_refactor_tool`
|
|
```
|
|
refactor_id: str # ID from prior refactor_tool call
|
|
repo_root: str | None
|
|
dry_run: bool = False # Return diff without writing files
|
|
```
|
|
|
|
### Wiki Tools
|
|
|
|
#### `generate_wiki_tool`
|
|
```
|
|
repo_root: str | None
|
|
force: bool = False # Regenerate all pages even if unchanged
|
|
```
|
|
|
|
#### `get_wiki_page_tool`
|
|
```
|
|
community_name: str # Community name to look up
|
|
repo_root: str | None
|
|
```
|
|
|
|
### Multi-Repo Tools
|
|
|
|
#### `list_repos_tool`
|
|
```
|
|
(no parameters)
|
|
```
|
|
|
|
#### `cross_repo_search_tool`
|
|
```
|
|
query: str
|
|
kind: str | None
|
|
limit: int = 20
|
|
```
|
|
|
|
## MCP Prompts (7 workflow templates)
|
|
|
|
### `review_changes`
|
|
Pre-commit review workflow using detect_changes, affected_flows, and test gaps.
|
|
```
|
|
base: str = "HEAD~1"
|
|
```
|
|
|
|
### `architecture_map`
|
|
Architecture documentation using communities, flows, and Mermaid diagrams.
|
|
|
|
### `debug_issue`
|
|
Guided debugging using search, flow tracing, and recent changes.
|
|
```
|
|
description: str = ""
|
|
```
|
|
|
|
### `onboard_developer`
|
|
New developer orientation using stats, architecture, and critical flows.
|
|
|
|
### `pre_merge_check`
|
|
PR readiness check with risk scoring, test gaps, and dead code detection.
|
|
```
|
|
base: str = "HEAD~1"
|
|
```
|
|
|
|
### `unified_review`
|
|
Three-layer unified review: CRG graph context + objective scoring
|
|
(`score_review`), finding merge (`dedupe_findings`), and the standalone
|
|
HTML report (`generate_report`). READ-ONLY: every finding waits for a
|
|
manual fix decision.
|
|
```
|
|
base: str = "HEAD~1"
|
|
tier: str = "standard" # fast | standard | strict
|
|
```
|
|
|
|
### `project_review`
|
|
Whole-project or single-feature code review (not diff-based). Reviews
|
|
the entire codebase or a single feature/module using graph-wide analysis
|
|
and objective scoring. READ-ONLY: every finding waits for a manual fix
|
|
decision. Scope is parsed from the user instruction (全面/整个项目 →
|
|
whole-project; otherwise feature + target keyword).
|
|
```
|
|
scope: str = "whole-project" # whole-project | feature
|
|
target: str = "" # feature/module keyword when scope="feature"
|
|
```
|
|
|
|
## CLI Commands
|
|
|
|
```bash
|
|
# Setup
|
|
code-review-graph install # Configure detected AI coding platforms (alias: init)
|
|
code-review-graph install --dry-run # Preview without writing files
|
|
code-review-graph install --platform codex # Configure one platform
|
|
code-review-graph uninstall # Remove all CRG configs, hooks, skills, and data
|
|
code-review-graph uninstall --platform codex # Unbind one platform (keeps graph data + others)
|
|
|
|
# Build and update
|
|
code-review-graph build # Full build
|
|
code-review-graph build --skip-flows # Parse + signatures + FTS only
|
|
code-review-graph build --skip-postprocess # Raw parse only
|
|
code-review-graph update # Incremental update
|
|
code-review-graph update --base origin/main # Custom base ref
|
|
code-review-graph update --brief # Update graph + show risk panel
|
|
code-review-graph update --brief --verify # ...and cross-check vs tiktoken
|
|
code-review-graph postprocess # Re-run flows, communities, FTS
|
|
code-review-graph forget PATH [PATH ...] # Drop parsed files from the graph (no full rebuild)
|
|
code-review-graph forget src/legacy --dry-run # Preview which files would be forgotten
|
|
code-review-graph embed --provider local # Compute vector embeddings for semantic search
|
|
code-review-graph update --embedding-provider local --embedding-model all-MiniLM-L6-v2
|
|
# Explicitly refresh an existing index (default: off)
|
|
|
|
# Monitor and inspect
|
|
code-review-graph status # Graph statistics
|
|
code-review-graph watch # Auto-update on file changes
|
|
code-review-graph visualize # Generate interactive HTML graph
|
|
code-review-graph visualize --format graphml # Export GraphML
|
|
code-review-graph visualize --serve # Serve graph.html on localhost:8765
|
|
|
|
# Analysis
|
|
code-review-graph detect-changes # Risk-scored change analysis
|
|
code-review-graph detect-changes --base HEAD~3 # Custom base ref
|
|
code-review-graph detect-changes --brief # Compact panel with token-savings estimate
|
|
code-review-graph detect-changes --brief --verify # ...and cross-check vs tiktoken
|
|
code-review-graph detect-changes --churn # Add opt-in change-frequency risk
|
|
|
|
# detect-changes vs update --brief — which one?
|
|
# • detect-changes --brief: read-only. Asks "what's the impact of my current
|
|
# changes against the existing graph?" Fast (~1s). Use this when the graph
|
|
# is already up to date (the default, if you have hooks installed).
|
|
# • update --brief: re-parses your changed files into the graph FIRST, then
|
|
# runs the same analysis at the end. Use this after a rebase, a big
|
|
# change set, or whenever you suspect the graph is stale.
|
|
# Both end with an identical "Token Savings" panel.
|
|
|
|
# Wiki
|
|
code-review-graph wiki # Generate markdown wiki from communities
|
|
|
|
# Multi-repo
|
|
code-review-graph register <path> [--alias name] # Register a repository
|
|
code-review-graph unregister <path_or_alias> # Remove from registry
|
|
code-review-graph repos # List registered repositories
|
|
|
|
# Daemon (multi-repo watcher) — included with install, no extra dependencies
|
|
code-review-graph daemon start [--foreground] # Start the watch daemon
|
|
code-review-graph daemon stop # Stop the daemon
|
|
code-review-graph daemon restart [--foreground] # Restart the daemon
|
|
code-review-graph daemon status # Show daemon status and repos
|
|
code-review-graph daemon logs [--repo ALIAS] [--follow] # View daemon or per-repo logs
|
|
code-review-graph daemon add <path> [--alias NAME] # Add a repo to daemon config
|
|
code-review-graph daemon remove <path_or_alias> # Remove a repo from daemon config
|
|
|
|
# Evaluation
|
|
code-review-graph eval # Run evaluation benchmarks
|
|
|
|
# Server
|
|
code-review-graph serve # Start MCP server (stdio)
|
|
code-review-graph serve --http # Streamable HTTP on localhost:5555
|
|
code-review-graph serve --tools query_graph_tool,detect_changes_tool # Tool allowlist
|
|
code-review-graph mcp # Alias for serve
|
|
```
|
|
|
|
## Standalone Daemon CLI (`crg-daemon`)
|
|
|
|
The `crg-daemon` command is included with every `code-review-graph` installation — no
|
|
separate install required. It is also available as a standalone entry point. It mirrors the
|
|
`code-review-graph daemon` subcommands:
|
|
|
|
```bash
|
|
crg-daemon start [--foreground] # Start the multi-repo watch daemon
|
|
crg-daemon stop # Stop the daemon and all watcher processes
|
|
crg-daemon restart [--foreground] # Restart (stop + start)
|
|
crg-daemon status # Show daemon status, repos, and process liveness
|
|
crg-daemon logs [--repo ALIAS] [-f] [-n N] # Tail daemon or per-repo log files
|
|
crg-daemon add <path> [--alias NAME] # Add a repository to watch.toml
|
|
crg-daemon remove <path_or_alias> # Remove a repository from watch.toml
|
|
```
|
|
|
|
### Configuration
|
|
|
|
The daemon reads its configuration from `~/.code-review-graph/watch.toml`:
|
|
|
|
```toml
|
|
session_name = "crg-watch" # logical daemon name
|
|
log_dir = "~/.code-review-graph/logs"
|
|
poll_interval = 2 # seconds between config file polls
|
|
|
|
[[repos]]
|
|
path = "/home/user/project-a"
|
|
alias = "project-a"
|
|
|
|
[[repos]]
|
|
path = "/home/user/project-b"
|
|
alias = "project-b"
|
|
```
|
|
|
|
The daemon spawns one `code-review-graph watch` child process per repo,
|
|
managed via `subprocess.Popen`. It monitors the config file for changes and
|
|
automatically reconciles child processes (starting/stopping as repos are
|
|
added or removed). Health checks run every 30 seconds and automatically
|
|
restart dead watchers. No external dependencies (tmux, screen, etc.) are
|
|
required.
|