How the docs are organized
The Apex docs are organized around the workflow most teams follow: connect code, define the workspace, choose the right scan workflow, and then run or automate it from the app, GitHub, or CLI.
Use this page as the entry point when you are deciding which guide belongs to the next step in setup or scan planning.
Key idea
Guides
Scan workflow
Apex works best when the workspace reflects a real security surface, not a loose collection of unrelated directories. The path below keeps access, scope, context, and scan type aligned before work starts.
- Connect a code host or use the CLI from the repository you want to scan.
- Create a workspace and choose the repositories, branches, pull requests, or commits in scope.
- Add private docs, architecture notes, API specs, and threat model details that are not obvious from the code.
- Run the workflow that matches the question: full scan for a system, PR Scan for a proposed diff, or Fix Review for an existing finding.
- Use the CLI or workspace UI to track progress, read findings, and export results.
Before the first scan
Make sure the person approving repository access and the person deciding scan scope agree on the same repos, refs, and supporting materials.
PR scans and Fix Review
Not every security question needs the same scan shape. Apex now has focused workflows for pull request review and for verifying fixes against existing findings.
- Use PR Scan when the review target is one or more GitHub pull requests or GitLab merge requests and you want focused diff coverage before merge.
- Use Fix Review when an existing finding has a proposed fix and Apex should verify whether the original issue is actually resolved.
- Use scheduled scans for recurring workspace coverage, and scheduled Fix Review when eligible findings should be rechecked automatically on a cadence.
Fix Review has its own workflow guide
Read the Fix Review workflow guide when you need the full path from fix target selection through provider handoff, bulk review, scheduled review, and final verdicts.
Reference
The CLI guide is the canonical reference for local and agent-driven workflows. The service API guide covers static-token, headless HTTP integrations for serverless workers and audit hubs.
- Read client onboarding if you are setting up a workspace for the first time.
- Read the scan manual before choosing between full scans, PR scans, Fix Review, or a split large-repo plan.
- Use the CLI guide when you want Apex available directly inside developer and agent workflows.
- Use the service API when a serverless function, cron job, or internal audit hub needs static-token HTTP access.