Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.peaq.xyz/llms.txt

Use this file to discover all available pages before exploring further.

peaqOS ships one curated agent skill — peaqos — that turns your AI agent into a peaqOS onboarding co-pilot. It’s a skill.md-spec skill with first-class adapters for Claude Code, Cursor, and Windsurf, plus a manual upload path for any other runtime that reads the standard. Under the hood it drives the peaqos Python CLI — anything you can do at the terminal, the skill can do for you with the right questions asked first.

​
What the skill does

Trigger it in your agent (/peaqos in Claude Code, or just describe what you want elsewhere) and it picks the right mode based on what you ask:
ModeWhen it kicks in
DemoFirst-time tour on agung testnet — full onboarding in ~15 minutes with explanations at every step.
Real onboardingAsks five questions about your machine and deployment, recommends self-managed or proxy-managed architecture, then runs the CLI to register, mint the Machine NFT, and submit the first event.
Fleet managementPulls MCR scores for an operator’s fleet, surfaces machines with low or no rating, submits heartbeat events.
TroubleshootingDiagnoses common failures — funding, activation, MCR lag, key mismatches — and walks you through the fix.
The skill adapts its tone to your background: concise for developers, plain English with narrated steps for non-technical operators.

​
Install

Two pieces. The CLI does the actual work; the skill is the orchestration layer your agent loads.

​
1. Install the CLI

python3 -m venv .peaqos-env
source .peaqos-env/bin/activate
pip install peaq-os-cli
peaqos --version
Python 3.10 or newer is required.

​
2. Add the skill to your agent

# Auto-detect (Claude Code, Cursor, or Windsurf)
npx @peaqos/skills add peaqos

# Or target a specific runtime
npx @peaqos/skills add peaqos --agent claude-code
npx @peaqos/skills add peaqos --agent cursor
npx @peaqos/skills add peaqos --agent windsurf
The installer ships adapters for Claude Code, Cursor, and Windsurf, auto-detecting the agent it finds on disk (or prompting if multiple are installed). Invoke /peaqos (Claude Code) or just describe what you want (e.g. “onboard my machine to peaqOS”) in Cursor or Windsurf. For ChatGPT, Claude Projects, custom GPTs, or anywhere you can’t run a local CLI, clone the repo and upload AGENT-PROMPT.md as the system prompt with knowledge/ and GUIDE.md as knowledge sources: 
git clone https://github.com/peaqnetwork/peaq-os-skills

​
LLM context files

Separate from the curated skill, Mintlify auto-generates machine-readable bundles of these docs. Point any agent at one of:
FileURLUse when
llms.txthttps://docs.peaq.xyz/llms.txtModel has a modest context window or you want a compact index with links
llms-full.txthttps://docs.peaq.xyz/llms-full.txtModel has a large context window and you want the full docs inline
skill.mdhttps://docs.peaq.xyz/skill.mdAgent needs a doc-derived capabilities spec rather than prose docs
These are doc context, not a substitute for the curated peaqos skill — that one knows the onboarding flow, decision tree, and recovery paths; the auto-generated bundle just knows what’s on the page.

​
Editor setup (docs context)

Wire the peaq docs into your editor of choice. Independent of the peaqos skill — useful any time you want the agent to ground answers in current docs.
Open Cursor Settings → Features → Docs, click Add new doc, and paste:
https://docs.peaq.xyz/llms-full.txt
Reference peaq in chat with @docs → peaq.
Windsurf has no persistent docs store. Paste into Cascade (Cmd+L) per chat:
@docs:https://docs.peaq.xyz/llms-full.txt
Add the Mintlify-hosted MCP server to .mcp.json:
{
  "mcpServers": {
    "peaq-docs": { "url": "https://docs.peaq.xyz/mcp" }
  }
}
Or one-shot install with the Mintlify CLI:
npx @mintlify/mcp add docs.peaq.xyz
Same MCP URL: https://docs.peaq.xyz/mcp. For custom GPTs or Claude Projects, upload llms-full.txt as a knowledge source.

​
See also

peaqChain AI integrations

Chain-level prompting tips, Cursor Projects, peaq SDK prompt patterns.

SDK reference

The ground truth the skill calls into via the CLI.