Getting Started

Getting Started

Getting Started

Get up and running with Ossprey in just a few minutes. This guide walks you through creating your account and running your first scan.


Creating your account

    Click Sign Up or Log In
    You can sign up using email and password, or social login (Google or GitHub)
When you first log in, you'll be asked to complete a quick profile: enter your name, optionally provide company information, and accept terms and conditions. Once you've submitted your profile, your account will be reviewed. You'll receive an email once you're approved, and then you'll be taken to your dashboard home page.


Your first scan

You have multiple options for your first scan:

Option 1: Connect GitHub (Recommended)

The easiest way to get started is to connect your GitHub repositories:
    Navigate to GitHub Integrations in the sidebar
    Click Connect GitHub
    Select the organisation or account you want to connect
    Choose which repositories Ossprey can access
    Your repositories will begin scanning automatically

Option 2: Scan a package manually

Want to quickly check a specific package?
    Navigate to Scan Results in the sidebar
    Click Scan Online or visit the online scanner
    Enter the package details — name (e.g. lodash), version (e.g. 4.17.21), and ecosystem (e.g. npm, PyPI)
    Click Scan and wait for results

Option 3: Scan with the CLI

Install the Ossprey CLI and scan a local project from your terminal:
pip install ossprey
ossprey --api-key YOUR_KEY --package ./my-project
See the CLI Tool page for the full installation and usage guide.
PIC-TODO: Screenshot or terminal recording (GIF) showing the CLI output of a successful scan — the install, the scan command, and the "No malware found" result.


Understanding your dashboard

Once you have scans running, you can view the results on the Scan Results page.


Next steps

Once you've completed your first scan, we recommend:
  • Connecting your GitHub repositories for automated scanning.
  • Familiarising yourself with the dashboard to understand your scan results.
  • Setting up your API key for CLI and programmatic access.