Skip to main content

Scenario catalog

Choose a CodeGraph guide for analyzing, changing, or reviewing code. The catalog connects your task to its expected result and scenario limitations.

User Guides

Choose a guide for your task. It explains the commands, expected result, and limitations. Article numbers help you find a guide in this catalog; they do not always match scenario identifiers used by the API. Use the invocation identifier specified in the selected guide.

How to use the catalog

  1. Start from the job you need to complete.
  2. Choose one primary guide. Add a second if the task covers several areas.
  3. Before making changes, confirm the selected project and source revision. Run diagnostics without writing data.
  4. Review the analysis findings before deciding what to change.
  5. Save test results and approvals. Prepare a rollback and record the release result according to your project’s rules.

For example, when exploring a new repository, start with “01 — Onboarding”. Then open “11 — Architecture” to study component boundaries and dependencies. If your task is to review an existing pull request, start directly with “09 — Code review”.

Understand a codebase

Understand a codebase
Job Guide Expected result
Establish project context and find the first useful entry points 01 — Onboarding A bounded map of relevant modules and symbols
Produce or check source-linked documentation 03 — Documentation Documentation tied to resolvable code evidence
Review module boundaries and dependencies 11 — Architecture An architecture finding with an explicit impact zone
Trace behavior across registered repositories 10 — Cross-repository analysis Repository-qualified paths and unresolved boundary gaps
Find external input handlers for an attack-surface review 16 — Entry points Candidate entry points for source and runtime verification
Find a repeated structural pattern Pattern search Search results separated from any rewrite action

Security and compliance

Security and compliance
Job Guide Expected result
Inspect security findings without applying fixes 02 — Security audit Findings with source locations and severity context
Prepare a proposed security fix 02 — Security audit autofix Proposed diff and validation metadata for fix review
Run a compliance-oriented engineering check 08 — Compliance Evidence gaps and qualified assessment output
Investigate a security incident 14 — Incident response Affected-path hypotheses for manual incident investigation

Change and review

Change and review
Job Guide Expected result
Find integration points for a feature 04 — Feature development Candidate placement and affected contracts
Restructure code without intended behavior change 05 — Refactoring Before/after impact, tests, and a keep-or-rollback decision
Review a bounded change 09 — Code review Findings tied to the exact diff and base revision
Plan a repeated API or symbol migration 13 — Mass refactoring Candidate usages and a proposed migration sequence
Find optimization suggestions in a selected category 18 — Code optimization Optimization findings to verify before separate implementation
Check a change against coding standards 19 — Standards check Rule-specific findings and verification
Combine optimization or standards analysis Composite workflows Scenario 18 or 19 findings: merged results, deduplication and priorities

Diagnose and improve quality

Diagnose and improve quality
Job Guide Expected result
Investigate a performance concern 06 — Performance Static performance hypotheses and a measurement plan
Find test coverage gaps 07 — Test coverage Methods with no executed lines and prioritized test targets
Assess and prioritize technical-debt candidates 12 — Technical debt Prioritized debt items with source evidence
Trace an observed failure 15 — Debugging Candidate source locations for a reproduction experiment
Inspect dependency inventory and risks 20 — Dependencies Package inventory, vulnerability and license information, and SBOM

Move from analysis to a change

For code changes, choose the feature development, refactoring or security-fix guide. It connects proposed changes to authorization, tests and rollback. First verify the analysis findings and obtain approval for the selected change according to your project’s rules.