Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pluxx.dev/llms.txt

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

Use this page to choose the next command without reading the whole CLI reference.

​
Pick your path

SituationRun thisWhy
You have a raw MCP URL or stdio commandpluxx init --from-mcp <source> --yesCreates the first source project without invoking a host agent
You already configured the MCP in Claude Code, Cursor, Codex, or OpenCodepluxx discover-mcp then pluxx init --from-installed-mcp <host:name> --yesImports the existing MCP shape without copying literal secret values
You want import, refinement, build, install, and verification in one flowpluxx autopilot --from-mcp <source> --runner codex --mode standard --install --install-target codex --trustFastest end-to-end proof in one selected host
You already have a Pluxx project and the MCP changedpluxx sync --from-mcp <source>Refreshes generated MCP-derived content while preserving custom sections
You already have a host-native pluginpluxx migrate <path>Converts an existing plugin into a Pluxx source project

​
Normal manual flow

Use this when you want to inspect each stage: 
npx @orchid-labs/pluxx init --from-mcp https://example.com/mcp --yes --name acme
cd acme
npx @orchid-labs/pluxx doctor
npx @orchid-labs/pluxx lint
npx @orchid-labs/pluxx eval
npx @orchid-labs/pluxx test
Add local install proof: 
npx @orchid-labs/pluxx test --install
npx @orchid-labs/pluxx verify-install --target codex
If the plugin contains local hook commands, review them first, then pass --trust: 
npx @orchid-labs/pluxx test --install --trust

​
When to use Agent Mode

Use Agent Mode only after the deterministic scaffold is valid but still reads too generic, too lexical, or too tool-shaped. 
npx @orchid-labs/pluxx agent prepare \
  --docs https://docs.example.com/overview \
  --website https://example.com

npx @orchid-labs/pluxx agent run taxonomy --runner codex
npx @orchid-labs/pluxx agent run instructions --runner codex
Use review when you want critique before shipping: 
npx @orchid-labs/pluxx agent run review --runner codex --no-verify

​
What each check answers

CommandQuestion it answers
doctorIs the source project structurally healthy?
lintWill platform-specific rules reject this?
evalIs the scaffold coherent enough to publish or refine?
testDo config, lint, build, and smoke checks pass together?
verify-installDoes the host-visible installed bundle actually exist and work?
For every flag and edge case, use CLI Reference.