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

# Quickstart

> Get up and running with Corridor in under 5 minutes.

Get up and running with Corridor in a few quick steps. This assumes you have a Corridor account (sign up at [app.corridor.dev](https://app.corridor.dev)) and access to the code repository you want to secure.

## Prerequisites

* A Corridor account ([sign up](https://app.corridor.dev))
* A supported IDE or AI coding tool (VS Code, Cursor, Claude Code, Windsurf, Factory, Devin, or any MCP-compatible tool)
* A GitHub repository to connect

## Step 1: Connect GitHub

In the Corridor web app, you'll be prompted to connect your GitHub account or organization. Authorize the Corridor GitHub App with the necessary permissions.

<Steps>
  <Step title="Sign in to Corridor">
    Go to [app.corridor.dev](https://app.corridor.dev) and sign in with your GitHub account.
  </Step>

  <Step title="Authorize GitHub">
    Click **Connect GitHub** and authorize the Corridor GitHub App. You can grant access to **All repositories** or select specific repos—be sure to include any repos you want Corridor to monitor.
  </Step>
</Steps>

<Tip>
  Corridor needs read access to code and permission to write PR comments to perform reviews.
</Tip>

## Step 2: Add a project (repository)

Once GitHub is connected, add a repository as a Project in Corridor.

<Steps>
  <Step title="Go to Projects">
    In the Corridor dashboard, go to **Projects** and click **New Project**.
  </Step>

  <Step title="Select repository">
    Select the repo from the list to bring it under Corridor's protection. You must add a project before Corridor can analyze its code—simply connecting GitHub isn't enough.
  </Step>

  <Step title="Auto-generated guardrails">
    After adding, Corridor will scan the codebase and automatically generate initial security guardrails tailored to that project.
  </Step>
</Steps>

## Step 3: Install the IDE extension

To get real-time guardrails while coding, install Corridor's integration for your development environment:

<Tabs>
  <Tab title="VS Code / Cursor">
    1. Open VS Code or Cursor
    2. Go to the Extensions panel (`Cmd+Shift+X` or `Ctrl+Shift+X`)
    3. Search for "Corridor"
    4. Click **Install**
    5. Reload your editor when prompted

    After installation, you'll see the Corridor icon in your sidebar.

    <Note>
      **GitHub Copilot users:** If your organization manages Copilot through GitHub Enterprise, an admin must enable external MCP servers in the [Copilot policy settings](/ide-setup/vscode-cursor#enable-mcp-for-github-copilot) before Corridor's tools will appear.
    </Note>

    See [VS Code / Cursor setup](/ide-setup/vscode-cursor) for detailed instructions.
  </Tab>

  <Tab title="Claude Code">
    Integrate Corridor with Claude Code via the extension or CLI.

    **Option 1: VS Code / Cursor Extension**

    If you use Claude Code within VS Code or Cursor:

    1. Install the Corridor extension in VS Code or Cursor (see the VS Code / Cursor tab)
    2. Sign in to your Corridor account
    3. The extension automatically configures Claude Code's MCP settings

    **Option 2: CLI**

    If you use Claude Code as a standalone CLI:

    1. Install the Corridor CLI:
       ```bash theme={null}
       curl -fsSL https://app.corridor.dev/cli/install.sh | bash
       ```
    2. The installer will automatically set up the Corridor plugin, MCP server, and hooks

    See [Claude Code setup](/ide-setup/claude-code) for detailed instructions.
  </Tab>

  <Tab title="Factory">
    Integrate Corridor with Factory's AI Droid agents via MCP and hooks.

    1. Install the Corridor CLI:
       ```bash theme={null}
       curl -fsSL https://app.corridor.dev/cli/install.sh | bash
       ```
    2. The installer will automatically set up the Corridor plugin, MCP server, hooks, and agent rules

    See [Factory setup](/ide-setup/factory) for detailed instructions.
  </Tab>

  <Tab title="Devin">
    Integrate Corridor with Devin via MCP.

    1. Generate a Corridor API token at [app.corridor.dev/settings](https://app.corridor.dev/settings)
    2. In Devin, go to **Organization settings → MCP Marketplace** and add Corridor
    3. Add your token in the **Authorization Header** field
    4. Add new knowledge pinned to all repositories with a prompt instructing Devin to always call Corridor when generating code

    See [Devin setup](/ide-setup/devin) for detailed instructions.
  </Tab>

  <Tab title="Windsurf">
    1. Open the Extensions panel in Windsurf (`Cmd+Shift+X` or `Ctrl+Shift+X`)
    2. Search for "Corridor" and click **Install**
    3. Reload your editor when prompted
    4. Click the Corridor icon in the sidebar and sign in to your Corridor account

    See [Windsurf setup](/ide-setup/windsurf) for detailed instructions.
  </Tab>

  <Tab title="Custom MCP">
    Integrate Corridor with any MCP-compatible tool.

    1. Generate a Corridor API token in your [Corridor settings](https://app.corridor.dev/settings)
    2. Configure your MCP client with the following:
       ```json theme={null}
       {
         "mcpServers": {
           "corridor": {
             "transport": "http",
             "url": "https://app.corridor.dev/api/mcp?token={generated_token}"
           }
         }
       }
       ```
       Replace `{generated_token}` with your Corridor API token.

    See [Custom MCP setup](/ide-setup/custom-mcp-servers) for detailed instructions.
  </Tab>
</Tabs>

## Step 4: (Optional) Invite team members

If you're on a Team or Enterprise plan, you can invite colleagues to join your Corridor workspace so they can benefit from the same guardrails and visibility.

<Steps>
  <Step title="Open Team Settings">
    Go to **Team Settings → Members**.
  </Step>

  <Step title="Invite members">
    Click **Invite Member**, enter their email, and select a role.
  </Step>
</Steps>

See [Inviting Teammates](/onboarding/adding-team-members) for details. Skip this if you're an individual user.

## You're all set

That's it—Corridor is now set up! From this point on:

* **In the IDE**: Your AI assistant (e.g. Cursor or Claude Code) will consult Corridor's guardrails as you generate code, stopping insecure suggestions
* **For Pull Requests**: Corridor will automatically review new PRs on your connected project. You'll see comments or checks on the PR if any vulnerabilities are found
* **Dashboard**: You can monitor findings and adjust settings via the [Corridor Dashboard](https://app.corridor.dev)

You've successfully onboarded Corridor to your project—secure coding can now happen in real-time without breaking your flow.

## Next steps

<CardGroup cols={2}>
  <Card title="Guardrails" icon="shield-check" href="/features/guardrails">
    Learn how real-time security analysis works
  </Card>

  <Card title="PR Reviews" icon="code-pull-request" href="/features/pr-reviews">
    Configure automated pull request reviews
  </Card>
</CardGroup>