Skip to main content
Nexus Design System
GitHub

AI agents

Your AI agent installs nxds with nxds-cli, exports it to Claude Design, learns the nxds rules from the nxds skills, and reads every docs page as Markdown.

Install with the CLI

npx nxds-cli@latest info --json
npx nxds-cli@latest add button --dry-run --json
npx nxds-cli@latest add button

The CLI never asks a question, so it runs inside any agent. info reports the app setup and the installed items. --dry-run shows the files and packages a command would change, and --json prints the result for the agent to read. Install lists every command.

With --json, a command prints one object: { "ok": true, "exitCode": 0, "data": … }, or { "ok": false, "exitCode": …, "error": "…" } if it fails.

Exit codeMeaning
0Done
1Error, such as no network or an invalid release
2Usage error, such as an unknown option or item
3Done, with something left for you: conflicts, kept files, manual steps or failed checks

Use nxds in Claude Design

npx nxds-cli@latest export claude-design

The command writes a nxds-design-system folder. Its SETUP.md walks the agent through publishing the system as a Design System artifact, installing it on a canvas and checking it. Your canvas then mounts every nxds component, shows its props as controls and lists the nxds tokens.

In a Claude chat, start from the Claude Design prompt instead.

OptionWhat it does
--release <v>Export that nxds release instead of the latest
--out <path>Write the folder somewhere else
--index <path>Keep the title and creation date from your system's current design-system.json
--existing <path>List, in removed.json, the files your system has that this release drops

SETUP.md's update steps use --index and --existing to republish over an existing system.

On the canvas, every prop is an attribute. A bare disabled is true, value="60" is a number and default-value="20,80" is a list. Each component's README in the folder lists the form its props take.

Name an icon as Canvas icons lists it, such as start-icon="plus". Draw a chart with Nxds.BarChart, Nxds.LineChart, Nxds.AreaChart or Nxds.PieChart, with its rows as JSON in data.

Add the nxds skills

Two skills teach your agent nxds:

SkillTells your agent to
nxdsCheck the setup first, add components with the CLI, and follow the nx: class and token rules
nxds-adoptAdd or swap one nxds component at a time in an app on another UI library, and keep the rest on that library

nxds-adopt covers the libraries on the Integrations pages. It never sweeps a whole screen or removes your library.

In Claude Code, the plugin installs both:

/plugin marketplace add nexuslabs-ai/nxds
/plugin install nxds@nxds

If you installed the plugin before nxds-adopt shipped, run /plugin marketplace update nxds to get it.

In Cursor, Codex, Gemini CLI and other agents that read skills:

npx skills add nexuslabs-ai/nxds --skill nxds nxds-adopt

Name both skills, because the repository also holds skills for nxds contributors.

Fetch the docs index

curl https://nxds.dev/llms.txt

/llms.txt lists every docs page, by section. Each entry links to the page's Markdown and gives a one-line summary.

Read one page as Markdown

Add .md to the URL of any page in /llms.txt to get that page as Markdown.

curl https://nxds.dev/getting-started/install.md

The Markdown keeps the page's text, tables and code. Live previews and copy buttons are left out, because they mean nothing as text. Links point at other pages' Markdown, so an agent can follow them.

To paste a page into a chat, click Copy page at the top of the page.

Fetch every page in one file

curl https://nxds.dev/llms-full.txt

/llms-full.txt holds the Markdown of every docs page, in nav order. It is about 2 MB, because it includes every code example. If your agent should pick pages itself, use /llms.txt.

Next steps

  • Install: set up an app for nxds components