> ## 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.

# Início Rápido

> Comece a usar a plataforma de segurança com IA da ZeroPath em apenas alguns minutos

<h2 id="signup">
  Cadastro
</h2>

1. Acesse [auth.zeropath.com/sign-up](https://auth.zeropath.com/sign-up) para criar sua conta
2. Escolha entre:
   * **Personal Workspace**: Plano gratuito para desenvolvedores individuais
   * **Organization**: Espaço de trabalho em equipe com recursos avançados

***

<h2 id="add-your-repo">
  Adicione seu repositório
</h2>

Dê à ZeroPath acesso para escanear seu código e realizar revisões automáticas de PR. <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" />

<h3 id="connection-method">
  Método de conexão
</h3>

<Tabs>
  <Tab title="GitHub App">
    Conecte repositórios do GitHub para revisões automatizadas de PR e escaneamento contínuo.

    <Steps>
      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) no seu painel da ZeroPath
      </Step>

      <Step title="Instale o GitHub App">
        Clique em "Install GitHub App" (a aba GitHub App já deve estar pré-selecionada)
      </Step>

      <Step title="Conclua o fluxo do GitHub">
        No lado do GitHub:

        1. Selecione sua organização
        2. Escolha os repositórios aos quais deseja conceder acesso
        3. Aprove o conjunto de permissões

        <Note>
          Se você ainda não estiver conectado à ZeroPath, será redirecionado primeiro para a página de login. Após fazer login, a instalação será retomada automaticamente.
        </Note>
      </Step>

      <Step title="Aguarde a sincronização">
        Você será redirecionado de volta à ZeroPath. Aguarde os repositórios aparecerem em "Accessible repositories" (um indicador de sincronização será exibido se o processamento ainda estiver em andamento)
      </Step>

      <Step title="Adicione os repositórios">
        Selecione quais repositórios adicionar à ZeroPath, ou clique em "Add All"

        <Note>
          Ative "Auto Add" para adicionar automaticamente novos repositórios quando você conceder acesso no futuro
        </Note>
      </Step>
    </Steps>
  </Tab>

  <Tab title="GitHub Enterprise Server">
    Conecte repositórios hospedados na sua própria instância do GitHub Enterprise Server (GHES).

    <Steps>
      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos\&tab=ghes) no seu painel da ZeroPath
      </Step>

      <Step title="Abra a aba GHES">
        Clique na aba **GitHub Enterprise Server**
      </Step>

      <Step title="Registre o app da ZeroPath">
        Insira o hostname da sua instância GHES (por exemplo, `github.example.com`). Se a sua instância usa um
        certificado autoassinado ou de uma CA interna, envie o pacote de CA para que a ZeroPath possa estabelecer
        uma conexão confiável.

        Clique em **Create App** para iniciar o fluxo de GitHub App Manifest. Você será redirecionado para a sua
        instância GHES para confirmar a criação do app.
      </Step>

      <Step title="Instale o app">
        Depois que o app for criado, você será redirecionado automaticamente para a página de instalação de apps
        da sua instância GHES. Selecione a organização cujos repositórios você deseja escanear e aprove
        as permissões.

        <Note>
          Se você não tiver permissão para instalar o app diretamente, sua solicitação será enviada a um
          proprietário da organização para aprovação. Os repositórios aparecerão assim que o proprietário aprovar
          a instalação.
        </Note>
      </Step>

      <Step title="Aguarde a sincronização">
        Você será redirecionado de volta à ZeroPath. Seus repositórios GHES começarão a sincronizar e
        aparecerão em "Accessible repositories" quando estiverem prontos.
      </Step>

      <Step title="Adicione os repositórios">
        Selecione quais repositórios adicionar à ZeroPath, ou clique em "Add All".
      </Step>
    </Steps>
  </Tab>

  <Tab title="GitHub Token">
    Conecte repositórios do GitHub usando um token de acesso pessoal, apenas para escaneamento.

    <Warning>
      Conexões baseadas em token têm recursos limitados: PRs automáticos, verificações de PR e outros fluxos do GitHub não estão disponíveis. Use o GitHub App para a funcionalidade completa.
    </Warning>

    <Steps>
      <Step title="Crie um token do GitHub">
        Acesse [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens) e crie uma das opções:

        * **Fine-grained token**: Com permissões de leitura para o conteúdo do repositório
        * **Classic token**: Com o escopo `repo` para acesso de leitura
      </Step>

      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) no seu painel da ZeroPath
      </Step>

      <Step title="Use um token de acesso">
        Clique no botão "Use An Access Token"
      </Step>

      <Step title="Insira o token e a URL do repositório">
        1. Cole seu token de acesso pessoal do GitHub
        2. Insira a URL completa do repositório do GitHub (por exemplo, `https://github.com/owner/repo`)
      </Step>

      <Step title="Adicione o repositório">
        Clique em "Add Repository" para concluir a integração baseada em token
      </Step>
    </Steps>
  </Tab>

  <Tab title="GitLab">
    Integre com o GitLab para escaneamento de merge requests e segurança de pipeline.

    <Steps>
      <Step title="Crie um token de acesso do GitLab">
        Crie um token de acesso de grupo ou de projeto no GitLab:

        1. Acesse as configurações do seu grupo/projeto no GitLab > Access Tokens
        2. Defina **Role** como "Maintainer"
        3. Adicione o **Scope** obrigatório: `api`
        4. Defina **Expiry** para 1 ano a partir de agora
        5. Clique em "Create token" e copie o token

        <Card title="Guia de tokens do GitLab" icon="gitlab" href="https://docs.gitlab.com/user/project/settings/project_access_tokens/">
          Consulte a documentação oficial do GitLab para ver as etapas detalhadas de criação de tokens
        </Card>
      </Step>

      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) no seu painel da ZeroPath
      </Step>

      <Step title="Configure a integração com o GitLab">
        1. Clique na aba "GitLab"
        2. Clique no botão "Setup GitLab Integration"
      </Step>

      <Step title="Configure a integração">
        1. Selecione o tipo de token: **Project** ou **Group**
        2. Insira o **GitLab Domain** (por exemplo, `gitlab.com` para clientes de nuvem)
        3. Cole seu **Access Token**
        4. Se estiver usando um token de grupo, insira o **Group Name**
      </Step>

      <Step title="Adicione os repositórios">
        Após a configuração, os repositórios aparecerão em "Accessible repositories". Selecione quais repositórios adicionar à ZeroPath.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Bitbucket">
    #### Opção 1: Integração OAuth (recomendada)

    <Steps>
      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) no seu painel da ZeroPath
      </Step>

      <Step title="Configure a integração com o Bitbucket">
        1. Clique na aba "Bitbucket"
        2. Clique no botão "Setup Bitbucket Integration"
      </Step>

      <Step title="Conclua o fluxo OAuth">
        Você será redirecionado para o Bitbucket para autorizar a ZeroPath. Isso habilita a funcionalidade completa, incluindo escaneamento de PRs, webhooks e revisões automatizadas.
      </Step>

      <Step title="Adicione os repositórios">
        Após o callback do OAuth, os repositórios aparecerão em "Accessible repositories" para seleção.
      </Step>
    </Steps>

    ### Opção 2: Token de acesso

    <Steps>
      <Step title="Crie um token de acesso do repositório">
        No Bitbucket, crie um novo token de acesso de repositório com estas permissões:

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

      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) no seu painel da ZeroPath
      </Step>

      <Step title="Use um token de acesso">
        1. Clique na aba "Bitbucket"
        2. Clique no botão "Use An Access Token"
        3. Insira seu token de acesso e a URL do repositório
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure DevOps">
    Conecte organizações do Azure DevOps Services para importação de repositórios, escaneamentos completos,
    escaneamentos de pull requests, verificações de status, comentários em PRs e pull requests de correção.

    <Note>
      O suporte ao Azure DevOps é para organizações de nuvem do Azure DevOps Services. O Azure DevOps Server
      não está incluído neste caminho de configuração.
    </Note>

    #### Opção 1: OAuth do Microsoft Entra (recomendada)

    <Steps>
      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos\&tab=azureDevOps) no seu painel da ZeroPath
      </Step>

      <Step title="Configure o Azure DevOps">
        Clique na aba **Azure DevOps** e, em seguida, clique em **Setup Azure DevOps**.
      </Step>

      <Step title="Insira a URL da sua organização">
        Insira a URL da sua organização do Azure DevOps Services, como
        `https://dev.azure.com/my-organization`.
      </Step>

      <Step title="Autorize a ZeroPath">
        Prossiga pela tela de consentimento do Microsoft Entra. A ZeroPath armazena material de credencial
        criptografado e o utiliza para listar repositórios, criar service hooks, escanear pull requests e abrir
        pull requests de correção.
      </Step>

      <Step title="Adicione os repositórios">
        Após o callback do OAuth, os repositórios aparecem em **Accessible repositories**. Selecione
        os repositórios que deseja adicionar, ou clique em **Add all accessible Azure DevOps repositories**.
      </Step>
    </Steps>

    #### Opção 2: Token de acesso pessoal

    <Steps>
      <Step title="Crie um PAT do Azure DevOps">
        No Azure DevOps Services, crie um PAT com acesso de leitura/gravação a repositórios, acesso de
        leitura/gravação a threads de pull request, acesso a status/build e acesso de gerenciamento de service hooks.
      </Step>

      <Step title="Use o formulário de configuração com PAT">
        Na caixa de diálogo de configuração do Azure DevOps, alterne para **Personal Access Token**, insira a
        URL da sua organização e o PAT e, em seguida, clique em **Connect with PAT**.
      </Step>

      <Step title="Adicione os repositórios">
        Depois que a ZeroPath validar o token, importe repositórios individuais, lotes selecionados ou todos
        os repositórios acessíveis.
      </Step>
    </Steps>

    <Card title="Guia de integração com o Azure DevOps" icon="git-branch" href="/integrations/azure-devops">
      Consulte o guia completo de configuração, escopo e solução de problemas do Azure DevOps.
    </Card>
  </Tab>

  <Tab title="Public Git URL">
    Escaneie qualquer repositório Git acessível publicamente fornecendo sua URL.

    <Steps>
      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) no seu painel da ZeroPath
      </Step>

      <Step title="Selecione Public Git URL">
        Clique em "Public Git URL"
      </Step>

      <Step title="Insira os detalhes do repositório">
        1. Insira a URL do repositório Git público (por exemplo, `https://github.com/user/repo.git`)
        2. Selecione o branch a ser escaneado
        3. Configure as opções de escaneamento
      </Step>

      <Step title="Inicie o escaneamento">
        Clique em "Start Scan" para iniciar a análise única
      </Step>
    </Steps>
  </Tab>

  <Tab title="Code Upload">
    Envie seu código-fonte como um arquivo ZIP para uma análise de segurança única.

    <Steps>
      <Step title="Prepare o repositório em ZIP">
        Certifique-se de ter um repositório real compactado em ZIP
      </Step>

      <Step title="Navegue até Add Repositories">
        Acesse [Add Repositories](https://zeropath.com/app/repositories?m=AddRepos) no seu painel da ZeroPath
      </Step>

      <Step title="Envie o repositório">
        1. Clique em "Upload Repository"
        2. Nomeie seu repositório na interface
        3. Envie o arquivo ZIP (isso pode levar um minuto)
      </Step>
    </Steps>
  </Tab>

  <Tab title="CLI">
    Use nossa ferramenta de linha de comando para enviar e escanear código a partir do seu terminal.

    <Card title="Documentação da CLI" icon="terminal" href="/cli/introduction">
      Consulte o guia completo da CLI para instruções de instalação, autenticação e uso
    </Card>
  </Tab>
</Tabs>

<h3 id="review-basic-settings">
  Revise as configurações básicas
</h3>

Configure suas preferências de escaneamento:

* **Seleção de branch**: Escolha qual branch monitorar e verifique se ele existe
* **Escaneamento de PR**: Opcionalmente, desative as verificações automáticas de PR (habilitadas por padrão)
* **Configurações do scanner**: Por padrão, a ZeroPath vem configurada para SAST, SCA, IaC e Secrets, com um nível baixo de permissividade de confiança.

***

<h2 id="start-a-scan">
  Inicie um escaneamento
</h2>

1. Revise suas configurações
2. Clique em **"Start Scan"** para iniciar a análise
3. Seu escaneamento será processado em segundo plano

<h3 id="monitor-progress">
  Acompanhe o progresso
</h3>

Acompanhe o status do seu escaneamento:

* **Status do escaneamento**: Veja o progresso em [zeropath.com/app/scans](https://zeropath.com/app/scans)
* **Logs detalhados**: Clique em "Running time" para ver os logs do escaneamento
* **Notificações**: Configure alertas via [integração com o Slack](https://zeropath.com/app/settings/integrations) ou [webhooks](/webhook/introduction)
* **Tempo estimado**: Varia conforme o tamanho do repositório. Escaneamentos completos iniciais demoram mais enquanto o código-fonte é indexado, mas os escaneamentos seguintes são 10x mais rápidos

<Note>
  Escaneamentos de PR normalmente são concluídos em menos de um minuto, enquanto escaneamentos completos do repositório podem demorar mais na primeira execução.
</Note>

<h2 id="getting-help">
  Obtendo ajuda
</h2>

<CardGroup cols={2}>
  <Card title="Documentação" icon="book" href="https://zeropath.com/docs/api-reference/">
    Explore nossos guias e tutoriais completos
  </Card>

  <Card title="Comunidade" icon="users" href="https://discord.gg/ZRqDvZ6qjJ">
    Participe da nossa comunidade no Discord para dicas e suporte
  </Card>

  <Card title="Suporte" icon="headset" href="mailto:support@zeropath.com">
    Entre em contato com nossa equipe de suporte para obter assistência
  </Card>

  <Card title="Status" icon="signal" href="https://status.zeropath.com">
    Verifique o status e a disponibilidade da plataforma
  </Card>
</CardGroup>