AI Agents

Siteplane UI gives coding agents one evidence-backed workflow over editable source. The agent inspects the project and current registry instead of recreating components from memory.

1. Install the skill

The Skill follows the open SKILL.md format. Siteplane supports the separately versioned skills@1.5.21 CLI as its installer. The release replaces <full-commit> with the qualified immutable revision; replace <codex|claude-code> with the selected host:

pnpm dlx skills@1.5.21 add https://github.com/LukasvanUden/siteplane-ui/tree/<full-commit>/.agents/skills/siteplane-ui --skill siteplane-ui --agent <codex|claude-code> --copy --yes

The same instruction-only Skill and focused references are copied into the project-native location used by Codex CLI or Claude Code. Eval prompts, executable scripts and maintainer workflow are not included.

2. Inspect and configure the project

pnpm dlx shadcn@4.16.1 info --json

Until the proposed @siteplane entry is merged into the official shadcn Registry Directory and passes the live CLI check, add the normal explicit namespace to components.json:

{
  "registries": {
    "@siteplane": "https://ui.siteplane.io/r/{name}.json"
  }
}

3. Discover and install source

The catalog at /r/registry.json lets the standard shadcn CLI and MCP server list, search and inspect every published item:

pnpm dlx shadcn@4.16.1 list @siteplane
pnpm dlx shadcn@4.16.1 search @siteplane --query "searchable selection"
pnpm dlx shadcn@4.16.1 view @siteplane/combobox
pnpm dlx shadcn@4.16.1 add @siteplane/combobox
pnpm dlx shadcn@4.16.1 mcp init

No Siteplane-specific MCP server is required.

4. Compose and verify

1. Read components.json and the shadcn info --json result.
2. Search by intent before choosing a primitive or pattern.
3. View the selected item and read its embedded docs, dependencies and current source.
4. Install only missing items through the registry.
5. Compose product UI outside installed primitive files with documented APIs and system tokens.
6. Run the relevant code and browser checks and inspect the real interface.

For existing source-owned installs, review changes before applying them:

pnpm dlx shadcn@4.16.1 add @siteplane/button --diff

If installed source has local edits, treat it as a fork and reconcile it explicitly.

Starter prompt

Build this interface with Siteplane UI. Inspect components.json, the real project and
the current @siteplane registry first. Install only missing items, use documented
APIs and system tokens, then run the relevant checks and inspect the real UI.

Human docs and machine-readable context

Agent-first does not mean agent-only. Start with Getting Started, inspect the Registry, or read the current Button and Validated Form contracts directly.

• /llms.txt is the short discovery index.
• /llms-full.txt contains the complete public setup, selection, component and pattern contracts.
• /r/registry.json is the mutable searchable catalog.
• /r/v/0.1.0/registry.json is the immutable release catalog.
• /agent-evals.json is the qualified 0.1.0 evidence record: seven of seven Codex CLI workflows passed deterministic and browser grading plus the named screenshot review.

Compatibility copy may name only hosts present in the current qualified evidence record. The initial release publishes no rankings, comparative scores or reliability percentage. Claude Code remains an installation target without a behavioral compatibility claim.