Getting Started

Go from zero to a full audit in under a minute.

Installation

Install the Nerviq CLI globally via npm:

Requires Node.js 18+. Also available via npx @nerviq/cli for one-off use.

Navigate to any project directory and run:

terminal

$ nerviq audit

nerviq v1.0.0 — auditing project...

Detected: Next.js + TypeScript + Claude

Platform: Claude Code

Score: 91/100 (A)

Nerviq auto-detects your platforms, language, and framework. No configuration needed.

Audit a specific platform with the --platform flag:

terminal

$ nerviq audit --platform codex

Platform: Codex CLI

AGENTS.md ........... 18/20 checks

codex.json .......... 12/12 checks

Score: 88/100

Available platforms: claude, codex, gemini, copilot, cursor, windsurf, aider, opencode

If your project uses multiple AI coding agents, check for configuration drift:

terminal

$ nerviq harmony-audit

Platforms detected: Claude, Codex, Cursor

Drift score: 12% — 3 misalignments found

Run nerviq harmony-fix to align.

Generate best-practice configuration from scratch:

terminal

$ nerviq setup

Interactive setup wizard

? Select platforms: Claude, Codex

? Language: TypeScript

? Framework: Next.js

Generated 14 files with 412 optimized checks.

All available commands and flags:

Command	Description
nerviq audit	Run full audit on current project
nerviq audit --platform <p>	Audit specific platform
nerviq audit --format json	Output as JSON
nerviq audit --ci	CI mode (exit code = score < threshold)
nerviq fix	Generate and apply fixes
nerviq fix --dry-run	Preview fixes without applying
nerviq fix --rollback	Undo last fix
nerviq harmony-audit	Cross-platform drift check
nerviq harmony-fix	Align platforms automatically
nerviq setup	Interactive project setup
nerviq setup --platform <p>	Setup specific platform
nerviq synergy	Find amplification opportunities
nerviq mcp serve	Start MCP server
nerviq api serve	Start REST API server
nerviq --help	Show all commands