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

# Quick Start

> Get started with ZeroPath's AI-powered security platform in just a few minutes

## Signup

1. Go to [auth.zeropath.com/sign-up](https://auth.zeropath.com/sign-up) to create your account
2. Choose between:
   * **Personal Workspace**: Free tier for individual developers
   * **Organization**: Team workspace with advanced features

***

## Add Your Repo

Give ZeroPath access to scan your code and perform automatic PR reviews. <img src="https://mintcdn.com/zeropath/FGvg_-Qn2HsSNCAl/images/addRepoNewFinal.gif?s=31cc658b89adad87f8aec3e84a7636b0" alt="Add Repo New Final Gi" width="1204" height="720" data-path="images/addRepoNewFinal.gif" />

### Connection Method

<Tabs>
  <Tab title="GitHub App">
    Connect GitHub repositories for automated PR reviews and continuous scanning.

    <Steps>
      <Step title="Navigate to Add Repositories">
        Go to [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) in your ZeroPath dashboard
      </Step>

      <Step title="Install GitHub App">
        Click "Install GitHub App" (GitHub App tab should be pre-selected)
      </Step>

      <Step title="Complete GitHub Flow">
        On GitHub's side:

        1. Select your organization
        2. Choose repositories to grant access to
        3. Approve the permission set

        <Note>
          If you are not already logged in to ZeroPath, you will be redirected to the login page first. After logging in, the installation will resume automatically.
        </Note>
      </Step>

      <Step title="Wait for Sync">
        You'll be redirected back to ZeroPath. Wait for repositories to appear under "Accessible repositories" (syncing indicator will show if still processing)
      </Step>

      <Step title="Add Repositories">
        Select which repositories to add to ZeroPath, or click "Add All"

        <Note>
          Enable "Auto Add" to automatically add new repositories when you grant access in the future
        </Note>
      </Step>
    </Steps>
  </Tab>

  <Tab title="GitHub Token">
    Connect GitHub repositories using a personal access token for scanning only.

    <Warning>
      Token-based connections have limited features: auto PRs, PR checks, and other GitHub flows are not available. Use GitHub App for full functionality.
    </Warning>

    <Steps>
      <Step title="Create GitHub Token">
        Go to [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens) and create either:

        * **Fine-grained token**: With read permissions for repository contents
        * **Classic token**: With `repo` scope for read access
      </Step>

      <Step title="Navigate to Add Repositories">
        Go to [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) in your ZeroPath dashboard
      </Step>

      <Step title="Use Access Token">
        Click "Use An Access Token" button
      </Step>

      <Step title="Enter Token and Repository URL">
        1. Paste your GitHub personal access token
        2. Enter the full GitHub repository URL (e.g., `https://github.com/owner/repo`)
      </Step>

      <Step title="Add Repository">
        Click "Add Repository" to complete the token-based integration
      </Step>
    </Steps>
  </Tab>

  <Tab title="GitLab">
    Integrate with GitLab for merge request scanning and pipeline security.

    <Steps>
      <Step title="Create GitLab Access Token">
        Create either a group or project access token in GitLab:

        1. Go to your GitLab group/project settings > Access Tokens
        2. Set **Role** to "Maintainer"
        3. Add required **Scope**: `api`
        4. Set **Expiry** to 1 year from now
        5. Click "Create token" and copy the token

        <Card title="GitLab Token Guide" icon="gitlab" href="https://docs.gitlab.com/user/project/settings/project_access_tokens/">
          See GitLab's official documentation for detailed token creation steps
        </Card>
      </Step>

      <Step title="Navigate to Add Repositories">
        Go to [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) in your ZeroPath dashboard
      </Step>

      <Step title="Setup GitLab Integration">
        1. Click the "GitLab" tab
        2. Click "Setup GitLab Integration" button
      </Step>

      <Step title="Configure Integration">
        1. Select token type: **Project** or **Group**
        2. Enter **GitLab Domain** (e.g., `gitlab.com` for cloud customers)
        3. Paste your **Access Token**
        4. If using a group token, enter the **Group Name**
      </Step>

      <Step title="Add Repositories">
        After configuration, repositories will appear under "Accessible repositories". Select which repositories to add to ZeroPath.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Bitbucket">
    #### Option 1: OAuth Integration (Recommended)

    <Steps>
      <Step title="Navigate to Add Repositories">
        Go to [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) in your ZeroPath dashboard
      </Step>

      <Step title="Setup Bitbucket Integration">
        1. Click the "Bitbucket" tab
        2. Click "Setup Bitbucket Integration" button
      </Step>

      <Step title="Complete OAuth Flow">
        You'll be redirected to Bitbucket to authorize ZeroPath. This enables full functionality including PR scanning, webhooks, and automated reviews.
      </Step>

      <Step title="Add Repositories">
        After the OAuth callback, repositories will appear under "Accessible repositories" for selection.
      </Step>
    </Steps>

    ### Option 2: Access Token

    <Steps>
      <Step title="Create Repository Access Token">
        In Bitbucket, create a new repository access token with these permissions:

        * **Repository**: Read, Write
        * **Pull Requests**: Read, Write
        * **Webhooks**: Read and Write
      </Step>

      <Step title="Navigate to Add Repositories">
        Go to [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) in your ZeroPath dashboard
      </Step>

      <Step title="Use Access Token">
        1. Click the "Bitbucket" tab
        2. Click "Use An Access Token" button
        3. Enter your access token and repository URL
      </Step>
    </Steps>
  </Tab>

  <Tab title="Public Git URL">
    Scan any publicly accessible Git repository by providing its URL.

    <Steps>
      <Step title="Navigate to Add Repositories">
        Go to [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) in your ZeroPath dashboard
      </Step>

      <Step title="Select Public Git URL">
        Click "Public Git URL"
      </Step>

      <Step title="Enter Repository Details">
        1. Enter the public Git repository URL (e.g., `https://github.com/user/repo.git`)
        2. Select the branch to scan
        3. Configure scan settings
      </Step>

      <Step title="Start Scan">
        Click "Start Scan" to begin the one-time analysis
      </Step>
    </Steps>
  </Tab>

  <Tab title="Code Upload">
    Upload your codebase as a ZIP file for one-time security analysis.

    <Steps>
      <Step title="Prepare ZIP Repository">
        Ensure you have a real repository zipped
      </Step>

      <Step title="Navigate to Add Repositories">
        Go to [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) in your ZeroPath dashboard
      </Step>

      <Step title="Upload Repository">
        1. Click "Upload Repository"
        2. Name your repository in the UI
        3. Upload the ZIP file (this may take a minute)
      </Step>
    </Steps>
  </Tab>

  <Tab title="CLI">
    Use our command-line tool to upload and scan code from your terminal.

    <Card title="CLI Documentation" icon="terminal" href="/cli/introduction">
      See the complete CLI guide for installation, authentication, and usage instructions
    </Card>
  </Tab>
</Tabs>

### Review Basic Settings

Set up your scan preferences:

* **Branch Selection**: Choose which branch to monitor and ensure they exist
* **PR Scanning**: Optionally, disable automatic PR Checks (enabled by default)
* **Scanner Settings**: By default, ZeroPath is configured for SAST, SCA, IaC, and Secrets by default, with a low confidence permissiveness setting.

***

## Start a Scan

1. Review your configuration settings
2. Click **"Start Scan"** to begin analysis
3. Your scan will process in the background

### Monitor Progress

Track your scan status:

* **Scan Status**: View progress at [zeropath.com/app/scans](https://zeropath.com/app/scans)
* **Detailed Logs**: Click on the "Running time" to view scan logs
* **Notifications**: Configure alerts via [Slack integration](https://zeropath.com/app/settings/integrations) or [webhooks](/webhook/introduction)
* **Estimated Time**: Varies by repository size. First-time full scans take longer while indexing the codebase, but subsequent scans are 10x faster

<Note>
  PR scans typically complete in under a minute, while full repository scans may take longer on the first run.
</Note>

## Getting Help

<CardGroup cols={2}>
  <Card title="Documentation" icon="book" href="https://zeropath.com/docs/api-reference/">
    Explore our comprehensive guides and tutorials
  </Card>

  <Card title="Community" icon="users" href="https://discord.gg/ZRqDvZ6qjJ">
    Join our Discord community for tips and support
  </Card>

  <Card title="Support" icon="headset" href="mailto:support@zeropath.com">
    Contact our support team for assistance
  </Card>

  <Card title="Status" icon="signal" href="https://status.zeropath.com">
    Check platform status and uptime
  </Card>
</CardGroup>