Skip to main content
In this guide you install the safedep CLI, sign in to SafeDep Cloud, activate a plan, and scan your first package. Setup takes a few minutes. Each scan takes a few minutes more. For what on-demand scanning is and when to use it, see the overview.
1

Install the safedep CLI

Verify with safedep version.
2

Sign in to SafeDep Cloud

This opens a browser-based device login. If you are new to SafeDep, it also sets up your account. The CLI keeps your session refreshed after this one sign-in.
3

Check your plan

On-demand scanning needs a Professional or Enterprise plan. If you do not have one yet, activate the free trial:
The command asks for basic billing profile details the first time. No payment method is needed for the trial. The trial includes one seat’s monthly scan allowance.
4

Scan a package

The CLI submits the scan and waits, showing status as the analysis progresses. When the scan completes you get a verdict panel: benign, malware, or inconclusive, with a confidence score. On a malware verdict the full evidence report is printed inline.The target can be a purl (as above), a GitHub URL, or an explicit triple:
5

Scan something that is not a registry package

On-demand scanning also covers components no registry-based tool can check. Scan a GitHub repository at a tag, branch, or commit:
Or a VS Code extension, named as publisher.extension:
6

Review your scans

List the tenant’s scans, newest first:
Fetch the full report of a completed scan, by package or by scan id:
Re-running scan run for the same package version returns the existing scan instead of starting (and counting) a new one. Use --rescan to force a new analysis.

​
Next steps

Scanning from CI and AI Agents

JSON output, verdict gating, polling, and the authentication model for automation.

Usage & On-Demand Billing

Check your scan allowance and enable usage-based billing beyond it.