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

# SafeDep Cloud Quickstart

> Get started with SafeDep Cloud in under 10 minutes

<Note>[GitHub App Integration](https://github.com/apps/safedep) is available for free. See [other integrations](/governance/integrations/overview) for more details</Note>

SafeDep Cloud is a control and data aggregation service that works with security tools like [Vet](https://github.com/safedep/vet).
This guide walks you through connecting Vet to SafeDep Cloud for centralized policy management and reporting.

## What You'll Accomplish

<CardGroup cols={2}>
  <Card title="Query by Risks" icon="search">
    Find critical vulnerabilities across all your projects
  </Card>

  <Card title="Policy Violations" icon="exclamation-triangle">
    Monitor and track policy violations from all Vet instances
  </Card>

  <Card title="Policy Management" icon="cogs">
    Test and deploy policies across all Vet deployments
  </Card>

  <Card title="Malware Analysis" icon="virus">
    Threat detection backed by cloud malware analysis
  </Card>
</CardGroup>

## Web Onboarding

<Steps>
  <Step title="Create Account">
    Navigate to [app.safedep.io](https://app.safedep.io/) and sign up
  </Step>

  <Step title="Create Tenant">
    Complete onboarding and create your tenant, noting the **Tenant Domain**
  </Step>

  <Step title="Generate API Key">
    Create an API key for use with Vet in your tenant settings
  </Step>
</Steps>

After completing onboarding, you should have:

* **Tenant Domain** (e.g., `your-company.safedep.io`)
* **API Key** for authentication

See [supported integrations](/governance/integrations/overview) for more details on how to integrate with your SDLC.

## Quick Onboarding with Vet CLI

The quickest path is the `vet cloud quickstart` command:

<Steps>
  <Step title="Install Vet">
    Ensure Vet is installed on your system:

    ```bash theme={null}
    brew tap safedep/tap
    brew install safedep/tap/vet
    ```
  </Step>

  <Step title="Run Quickstart">
    Run the command and follow the prompts:

    ```bash theme={null}
    vet cloud quickstart
    ```

    <iframe width="100%" height="315" src="https://www.youtube.com/embed/ykSiP547xuA" title="SafeDep Cloud Quickstart" frameBorder="0" allowFullScreen />
  </Step>
</Steps>

## Configure Vet with SafeDep Cloud

<Info>Skip this section if you used the `vet cloud quickstart` command</Info>

### Authentication Setup

Configure Vet to authenticate with your SafeDep Cloud tenant:

```bash theme={null}
vet auth configure --tenant <tenant-domain>
```

You'll be prompted to enter your API key securely.

### Verify Authentication

Confirm that your Vet instance can connect to SafeDep Cloud:

```bash theme={null}
vet auth verify
```

## Sync Data to SafeDep Cloud

Enable the sync reporting module to send Vet findings to SafeDep Cloud:

```bash theme={null}
vet scan -M /path/to/package-lock.json --report-sync \
  --report-sync-project my-project \
  --report-sync-project-version my-project-version
```

<Note>
  The example uses `package-lock.json`, but Vet supports many package manifest
  formats and code analysis.
</Note>

## GitHub Actions Integration

Configure [vet-action](https://github.com/safedep/vet-action) to sync with SafeDep Cloud:

<Steps>
  <Step title="Create Secrets">
    Add these [GitHub Action Secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions):

    * `SAFEDEP_CLOUD_API_KEY`
    * `SAFEDEP_CLOUD_TENANT_DOMAIN`
  </Step>

  <Step title="Update Workflow">
    Modify your vet-action workflow:

    ```yaml theme={null}
    - name: Run vet
      uses: safedep/vet-action@v1
      with:
        cloud: true
        cloud-key: ${{ secrets.SAFEDEP_CLOUD_API_KEY }}
        cloud-tenant: ${{ secrets.SAFEDEP_CLOUD_TENANT_DOMAIN }}
    ```
  </Step>
</Steps>

## Query Your Data

Once data is syncing, query your tenant's aggregated inventory and findings:
projects, packages, endpoints, and security findings enriched with threat
intelligence (vulnerabilities, EPSS, CISA KEV, OpenSSF Scorecard).

Queries run through the [`safedep` CLI](https://github.com/safedep/cli#safedep-cli).
For example, to find your top remediation targets by critical CVE count:

```bash theme={null}
safedep auth login
safedep query exec --sql "
  SELECT packages.name, COUNT(DISTINCT vulnerabilities.vuln_id) AS critical_vulns
  FROM packages
  JOIN component_vulnerabilities ON component_vulnerabilities.component_id = packages.id
  JOIN vulnerabilities ON vulnerabilities.vuln_id = component_vulnerabilities.vulnerability_id
  WHERE vulnerabilities.severity_rating = 'CRITICAL'
  GROUP BY packages.name
  ORDER BY critical_vulns DESC" --limit 15
```

<Note>
  Prefer a UI? You can also run queries from the web console at
  [app.safedep.io](https://app.safedep.io).
</Note>

See the **[SQL query guide](/reference/sql-query)** for the full schema, query
rules, and worked examples: severity breakdowns, EPSS enrichment, malware
findings, endpoint audit trails, and more.

## Next Steps

<CardGroup cols={2}>
  <Card title="Query with SQL" icon="magnifying-glass" href="/reference/sql-query">
    Explore your tenant data with the `safedep` CLI
  </Card>

  <Card title="Authentication Guide" icon="key" href="/governance/cloud/authentication">
    Learn advanced authentication and access control
  </Card>

  <Card title="Malware Analysis" icon="virus" href="/governance/cloud/malware-analysis">
    Enable enhanced threat detection capabilities
  </Card>

  <Card title="Cloud FAQ" icon="question-circle" href="/governance/cloud/faq">
    Find answers to common questions
  </Card>

  <Card title="API Documentation" icon="code" href="/reference/api-introduction">
    Integrate SafeDep Cloud with your systems
  </Card>
</CardGroup>