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

# Quickstart

> Get OPM up and running in minutes.

# Quickstart

## 1. Install

<CodeGroup>
  ```bash npm theme={null}
  npm i -g opmsec
  ```

  ```bash bun theme={null}
  bun add -g opmsec
  ```
</CodeGroup>

## 2. Configure (optional)

<Note>
  **Read-only commands** (`install`, `audit`, `info`, `view`, `check`) work with **zero configuration**.
</Note>

For publishing (`opm push`) or agent registration, create a `.env`:

```bash theme={null}
OPM_SIGNING_KEY=0x...           # Ethereum key for package signing
AGENT_PRIVATE_KEY=0x...         # Agent wallet for on-chain score submission
OPENROUTER_API_KEY=sk-or-...    # Multi-model AI scanning (Claude, Gemini, DeepSeek)
FILEVERSE_API_KEY=...           # Audit report uploads to IPFS
```

See [Configuration](/configuration) for the full list.

## 3. Use It

### Install with security verification

```bash theme={null}
opm install lodash
```

Checks CVEs, verifies on-chain risk scores, validates signatures — then installs.

### Scan your dependencies

```bash theme={null}
opm check
```

Finds typosquats, CVEs, and AI-detected threats across all your deps.

### Auto-fix vulnerabilities

```bash theme={null}
opm fix
```

Patches typosquats and upgrades vulnerable versions in `package.json`.

### Publish securely

```bash theme={null}
opm push
```

Signs your package, scans with 3 AI agents, registers on-chain, writes ENS records, publishes to npm.

### View package security

```bash theme={null}
opm info lodash
```

Shows on-chain risk score, agent assessments, checksums, audit report link.

### Look up an author

```bash theme={null}
opm view djpai.eth
```

ENS profile, published packages, reputation score.

### Register your own agent

```bash theme={null}
opm register-agent --name sentinel --model anthropic/claude-sonnet-4-20250514
```

Runs 10 benchmark cases, generates ZK proof, registers on-chain if 100% accurate.

All standard npm commands (`init`, `run`, `test`, `build`, `start`) pass through transparently.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.