Peak Studios CLI Reference

The official Peak Studios Command Line Interface (@peak-studios/cli / peakrp) enables developers, server operators, and AI coding agents to script interactions with Peak Studios products, inspect live service telemetry, read offline script documentation, and validate FiveM server configuration files.

You can run the CLI without installing via npx:

bash
npx peakrp status

Or install it globally via npm:

bash
npm install -g @peak-studios/cli
peak status

1. peak status

Checks API service health, live server telemetry, database status, and uptime metrics.

bash
peak status

2. peak scripts [--framework <name>]

Lists all public FiveM scripts in the Peak Studios catalog, showing repository links and supported frameworks (QBCore, ESX, QBX, Standalone).

bash
peak scripts
peak scripts --framework QBCore

3. peak doc <script-id>

Fetches and renders full Markdown documentation for a specific script directly in your terminal.

bash
peak doc peak-sprays
peak doc peak-trucking
peak doc peak-barbers

4. peak doctor

Scans your current directory and FiveM server.cfg to detect missing prerequisites, database drivers (oxmysql), and bridge dependencies.

bash
peak doctor

5. peak mcp

Outputs the Streamable HTTP Model Context Protocol (MCP) configuration snippet for Claude Code, Cursor, Copilot, or ChatGPT.

bash
peak mcp

6. peak info

Displays top-level Peak Studios metadata, social channels, and public endpoint URLs.

bash
peak info