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

# Get started with Octopoda

> Learn how to start an Octopoda trial, install the command-line tool, run your first security scan and fix what it finds, in about five steps.

This quickstart takes you from no account to a finished Octopoda scan of your own project. You need a GitHub account, a payment card for the free trial, and a Mac or Linux machine (on Windows, use WSL). A first scan usually takes 10 to 30 minutes.

**1. Start your free trial**

Go to [app.octopoda.dev/start](https://app.octopoda.dev/start) and sign in with GitHub. Pick a plan and continue to checkout on Stripe.

The trial lasts 14 days and includes 5 credits, enough for one code scan. Your card is not charged until the trial ends, and you can cancel any time before then. See [Free trial](https://docs.octopoda.dev/billing/free-trial.md).

**2. Install the CLI**

Run the installer in your terminal:

```bash theme={null}
curl -fsSL https://get.octopoda.dev | sh
```

It downloads the `octopoda` binary for your machine, checks it against the signed release list, and puts it on your `PATH`. See [Install the CLI](https://docs.octopoda.dev/cli/install.md) for options.

**3. Sign in this device**

```bash theme={null}
octopoda login
```

The CLI prints a code and opens your browser. Check that the code in the browser matches the one in your terminal, then approve. The terminal confirms:

```text theme={null}
✓ Signed in as @octocat in The Octocat.
Next: run octopoda scan in your project.
```

**4. Scan your project**

From your project folder, run:

```bash theme={null}
octopoda scan
```

The CLI packs your code (leaving out secrets such as `.env` files), uploads it and starts a code scan, which uses 5 credits. It then follows the scan and prints what Octopoda is doing. You can press **Ctrl+C** at any time: the scan keeps running, and you can check it later with `octopoda status`.

When the scan ends, the CLI lists each proven finding with its key, such as `F-1`, and where it is in your code.

**5. Fix a finding**

Print a finding's fix prompt:

```bash theme={null}
octopoda fix F-1
```

Paste the prompt into Cursor or Claude Code, review the change your AI tool makes, and scan again to confirm the issue is gone. See [Fix a finding with your AI tool](https://docs.octopoda.dev/findings/fix-with-ai.md).

> [!TIP]
>
> You can also start a scan from the web app: connect GitHub, choose your repositories, and select **New scan**.

## Next steps

> [card] [Check every pull request](https://docs.octopoda.dev/scanning/pull-request-checks.md)
>
> Install the GitHub App so new code is scanned before it merges.

> [card] [Scan from your AI tool](https://docs.octopoda.dev/integrations/mcp.md)
>
> Add Octopoda to Cursor or Claude Code over MCP.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.