Getting Started

Install OSE Auditor and perform your first security audit in minutes.

Welcome to OSE Auditor.

OSE Auditor helps developers and organizations identify security vulnerabilities before software reaches production. Whether you’re working on web applications, APIs, smart contracts, or modern software systems, getting started only takes a few minutes.

Install

Choose the installation method that best fits your workflow.

Method	Command
pipx (Recommended)	`pipx install ose-auditor`
npm (Global)	`npm install -g ose-auditor`
npx	`npx ose-auditor audit .`
pip (Virtual Environment)	`pip install ose-auditor`

OSE Auditor supports Python 3.9+.

Create Your Account

Create an account and authenticate the CLI.

ose signup
ose login

Verify your account:

ose whoami

Your account information and available credits will be displayed.

Run Your First Audit

Navigate to your project and run:

ose audit .

OSE Auditor analyzes your project and generates a security report highlighting detected vulnerabilities and recommended remediation.

To save the report:

ose audit . --output report.json

Understanding Credits

Every new account includes complimentary credits so you can begin auditing immediately.

Credits are only consumed when OSE successfully performs a security analysis that produces actionable findings.

Scans that produce no findings do not reduce your available balance.

For complete billing information, see Credits & Billing.

Typical Workflow

A common workflow looks like this:

ose login

ose audit .

ose whoami

Many teams incorporate OSE Auditor into their daily development process, running security audits before pull requests, releases, and production deployments.

Next Steps

Continue exploring OSE Auditor:

CLI Reference - Learn about available commands and options.
Credits & Billing - Understand plans, credits, and purchasing.
MCP Integration - Connect OSE Auditor to AI coding assistants for security-aware development workflows.

Welcome to OSE Auditor.