CLI Reference

Install, authenticate, and use the OSE Auditor CLI to perform security audits from your terminal.

The OSE CLI brings OSE Auditor directly into your terminal, making it easy to scan projects, integrate with development workflows, and automate security reviews.

To view all available commands at any time, run:

ose --help

Authentication

Authenticate once to securely connect the CLI to your OSE account.

Command	Description
`ose signup`	Create a new OSE account.
`ose login`	Sign in to an existing account.
`ose logout`	Sign out of the current account.
`ose whoami`	Display your current account and available credits.

Example:

ose login

ose whoami

Running a Security Audit

Audit an entire project from the command line.

ose audit ./my-project

Export the results to a JSON file:

ose audit ./my-project --output report.json

Common Options

Option	Description
`--output`, `-o`	Save the audit report to a JSON file.
`--debug`, `-d`	Display additional diagnostic output.

Purchasing Credits

Purchase additional credits directly from the CLI.

ose buy

Once payment is completed, your credit balance is updated automatically.

MCP Integration

Configure OSE Auditor for supported AI coding assistants.

ose mcp setup

OSE automatically detects supported environments and configures the integration for your authenticated account.

For more information, see the MCP Integration guide.

Typical Workflow

A common development workflow looks like this:

ose login

ose audit .

ose whoami

Many developers integrate OSE into pull requests, CI/CD pipelines, and release validation to identify vulnerabilities before software reaches production.

Troubleshooting

Issue	Resolution
`ose` command not found	Verify that the CLI is installed and available in your system’s PATH.
Authentication failed	Run `ose login` and verify your account credentials.
No projects detected	Ensure you’re running the command from a supported project directory.
MCP integration unavailable	Run `ose mcp setup` and restart your editor or AI assistant.

Need Enterprise Integration?

Organizations looking to integrate OSE into large-scale development environments, automated pipelines, or internal platforms can contact our sales team to discuss Enterprise deployment options.