> ## Documentation Index
> Fetch the complete documentation index at: https://www.oplane.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick start guide for Oplane threat modeling

> Set up Oplane threat modeling in under 5 minutes: connect your GitHub or GitLab repository, run your first scan, and review security findings on a PR.

Get security threat modeling running in your workflow in under 5 minutes. Choose your path below.

<CardGroup cols={3}>
  <Card title="Local with MCP" icon="terminal" href="/mcp-agent">
    Run threat models directly in Cursor, GitHub Copilot, or Claude Code while you write code.

    \~2 min setup
  </Card>

  <Card title="Connect GitHub" icon="github" href="/connect-github">
    Automated threat modeling on every pull request with inline review comments.

    \~5 min setup
  </Card>

  <Card title="Connect GitLab" icon="gitlab" href="/gitlab-setup">
    Automated threat modeling on every merge request. No app install needed.

    \~3 min setup
  </Card>
</CardGroup>

## How Oplane Works

<Steps>
  <Step title="Describe what changed">
    Oplane reads your code diff or you describe the feature you're building.
  </Step>

  <Step title="Get security requirements">
    Oplane generates targeted requirements based on your specific changes — not generic checklists.
  </Step>

  <Step title="Implement & resolve">
    Get implementation advice, mark requirements as resolved, or accept risks with justification.
  </Step>

  <Step title="Track your security posture">
    View organisation-wide analytics — resolution rates, requirement completion, and adoption across teams.
  </Step>
</Steps>

## Two Ways to Use Oplane

#### In your IDE

Connect via MCP and threat model while you code. Works with Cursor, GitHub Copilot, Claude Code, and any MCP-compatible client. No Git provider connection needed.

<Card title="Set up MCP" icon="terminal" href="/mcp-agent">
  Connect Oplane to your IDE for in-editor threat modeling.
</Card>

#### On PRs & MRs

Automated reviews on every pull request and merge request. Posts inline comments on affected lines. Trigger on-demand with `@oplane`.

<Card title="Learn about PR reviews" icon="git-pull-request" href="/github-prs">
  See how Oplane reviews your pull requests and merge requests.
</Card>

<Tip>
  Use both together for full coverage — catch issues locally while you develop, and let automated reviews ensure nothing slips through in code review.
</Tip>