AI Agents

Point Claude Code, Cursor, Copilot and other coding agents at the ShellUI docs, so they use its components instead of writing their own.

ShellUI publishes these docs for AI coding agents in the llms.txt format. An agent that reads them knows which components exist, how to install one with shellui add, and how each one is used, so it doesn't write its own versions.

Set up your project

Coding agents read an instructions file in the project root at the start of every session. Add ShellUI's rules to the one your agent reads: they tell it to use ShellUI's components, check what's installed, and run shellui add for anything missing, and they link these docs. Each file is a ## ShellUI section, so the commands append it to a file you already have, or create the file.

Claude Code reads CLAUDE.md. Download CLAUDE.md, or run this in the project root:

bash
curl -fsSL https://shellui.dev/docs/v0.4/agents/CLAUDE.md >> CLAUDE.md

The file is for ShellUI v0.4. When you upgrade, replace its ## ShellUI section with the one for the new version.

Or ask the agent

Paste this into your agent to have it read the docs and set up the instructions file itself:

text
Read https://shellui.dev/docs/v0.4/llms.txt and follow its rules in this project.
Then add the ShellUI section from https://shellui.dev/docs/v0.4/agents/AGENTS.md
to the instructions file you read at startup (AGENTS.md, CLAUDE.md or
.github/copilot-instructions.md), creating it if it doesn't exist.

For a one-off task, give it the docs with the task:

text
Read https://shellui.dev/docs/v0.4/llms.txt, then add a settings page with a form.

What agents can read

URL Contents
/docs/v0.4/llms.txt Rules for agents, then every page of these docs with a one-line description and, for components, the shellui add command
/docs/v0.4/llms-full.txt The rules and every page as Markdown in one file, examples included
Any page + .md One page as Markdown, for example /docs/v0.4/components/form/button.md
/llms.txt, /llms-full.txt The same for the current stable release, 0.4

Every page also has a ⋯ menu next to its title: Copy page copies its Markdown, View as Markdown opens it, and Open in Claude and Open in ChatGPT start a chat that reads it.

What the rules say

  • Look for an existing ShellUI component before building any UI element.
  • Check shellui.json (or shellui list --installed) for what the project has, and run shellui add <name> for what it doesn't. Never recreate a ShellUI component or port one from shadcn/ui.
  • Tell CLI projects (source in Components/UI) from NuGet projects (@using ShellUI.Components).
  • Give components an interactive render mode, follow each page's API reference, and style with the theme tokens so dark mode works.

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.