Skip to content

@docsxai/plugin

The first-class invocation surface for the docsxai engine.

The plugin calls the docsxai CLI, so install that first (Node 26+, and a one-time Chromium download):

npm install -g docsxai@next
npx playwright-core install chromium
docsxai doctor

@next is the 0.3.0 release candidate. For 0.2.0 (latest) install plain docsxai. This is the one place the plugin and skill files send you for install steps.

Then, from inside Claude Code, add the marketplace this repo publishes (.claude-plugin/marketplace.json at the repo root, marketplace name docsxai) and install the plugin:

/plugin marketplace add kalebteccom/docsxai
/plugin install docsxai@docsxai

The same from a shell:

claude plugin marketplace add kalebteccom/docsxai
claude plugin install docsxai@docsxai

The marketplace entry points at ./packages/plugin, which holds .claude-plugin/plugin.json. Both manifests pass claude plugin validate.

Verified: adding a local checkout as a marketplace (claude plugin marketplace add /path/to/docsxai) and installing docsxai@docsxai from it, in an isolated Claude Code config directory. Unverified: the kalebteccom/docsxai GitHub shorthand.

Load the plugin straight from a checkout, with no marketplace:

claude --plugin-dir /path/to/docsxai/packages/plugin

Commands (deterministic, thin wrappers over the docsxai CLI)

Section titled “Commands (deterministic, thin wrappers over the docsxai CLI)”

Each command passes its arguments to the CLI as single-quoted shell words. The CLI's own usage line and --help are the reference for every flag.

CommandWhat
/docsxai:run <workspace-dir>Re-run the flows headlessly, refresh annotations.json and screenshots. --variant and --verify-determinism pass through.
/docsxai:render <workspace-dir> [--lang <locale>]Build the interactive viewer.
/docsxai:push <workspace-dir>Upload the doc pack to the configured backend.
/docsxai:pull <workspace-dir>Download the doc pack from the configured backend.
/docsxai:loginBackend login: --oauth runs OAuth 2.1 + PKCE, CI uses DOCSX_TOKEN.
/docsxai:doctor [<workspace-dir>]Environment and workspace health-check (one ok: or fail: line per check, with a next: step).
/docsxai:plugins <list|info|sync> <workspace-dir>List, inspect, and sync (lock) the workspace's plugins.
/docsxai:export <adf|playwright> <workspace-dir>Export the doc pack as a Confluence ADF projection, or as Playwright specs.

The rest of the CLI has no slash command: init, capture-auth, add-flow (formerly calibrate), inspect, lint, flow-tree, diagnose, style, zip, baseline, diff, burn (annotations baked into PNG copies), and pack (the screenshot pack a docs site ships, with pack --check). Skills and agents call them through the shell; run docsxai --help for the flags.

When a command fails, its error carries an indented next: <command> line when there is one. A halted docsxai run prints a <flow>: next: <command> line for each failed flow on stderr and exits 1. A clean run ends with run: <n> of <m> flows ok, outputs in <dir> on stdout. Start-up failures print one reason and one next: line: no Chromium gives the install command, a refused --cdp endpoint names the endpoint and the --remote-debugging-port flag, a --app-url, --base-url or --backend-url that is not an http:// or https:// URL exits 2, and a Node older than 20 exits 1 with docsxai: Node v<version> is too old to start. docsxai doctor checks the environment and workspace, and docsxai diagnose explains a halted run (/docsxai:diagnose).

Skills (calibration, agent-driven; the host supplies inference)

Section titled “Skills (calibration, agent-driven; the host supplies inference)”
SkillWhat
add-flowAuthor a flow end-to-end: discovery → mapping+testing → commit, producing a doc pack. Formerly calibrate, deprecated since 0.3.0 and removed in 0.5.0.
diagnoseThe explicit failure path: propose a recalibration diff when a deterministic run halts on drift.

Invoke them as /docsxai:add-flow and /docsxai:diagnose, or let the agent load one when the request matches its description. /docsxai:calibrate still works as a short skill that points the agent at add-flow. It is deprecated since 0.3.0 and removed in 0.5.0.

The plugin registers no MCP server. The skills shell out to the docsxai CLI and use the externally-provided browxai MCP (any MCP browser bridge works) for the discovery stage's live-browser driving. Hosts that prefer MCP tools over shell-outs can register the standalone @docsxai/mcp server (engine operations as tools: run_flows, lint_flows, diagnose_halt, …; repo-only, see its README).

Made by KalebtecGitHubApache-2.0 licensed