CoherynUI — AI Coding Assistant & Agent Guide
Schema Version: 1.0
1. Core Principles for AI Assistants
When developing inside a CoherynUI codebase:
- Never Hallucinate Utilities: CoherynUI uses canonical utility tokens. Unrecognized classes will be flagged as
CY1001warnings by the compiler. - Leverage Machine-Readable Metadata: Query the MCP server or read
registry/index.jsonto inspect component props, accessibility invariants, and dependencies. - Always Validate Code Changes: Run
coherynui check --format jsonafter code mutations. Parse the structured output to auto-correct any diagnostic errors. - Respect Framework Agnosticism: Pure CSS styling does not require runtime JavaScript. Do not add
@coheryn/coherynui-react,@coheryn/coherynui-motion, or@coheryn/coherynui-gpu-materialsunless interactive React components, physics springs, or WebGPU shaders are specifically requested.
2. CLI Agent Tooling
# Verify agent configuration, discoverable instructions, and skills
coherynui agent doctor
# Propose project instructions (AGENTS.md) without overwriting
coherynui agent init --dry-run
coherynui agent init
# List and install versioned skills
coherynui agent skills list
coherynui agent skills install --target-dir .agent/skills
# Run Model Context Protocol server over stdio
coherynui mcp serve
3. Recommended Workflow
graph TD
A[Agent Receives User Prompt] --> B[Inspect Environment with 'coherynui agent doctor']
B --> C[Query Registry or Docs via MCP Tools]
C --> D[Generate Component / Layout Code]
D --> E[Run 'coherynui check --format json']
E --> F{Any Diagnostics?}
F -- Yes --> G[Apply Structured Fixes from CYxxxx]
G --> E
F -- No --> H[Run Application Tests & Complete]