Documentation
CLI Reference

CLI Reference

Complete reference for all Archyra command-line interface commands and options.

Quick Reference

npx archyra init

Interactive setup wizard

Launches an interactive prompt to select your AI coding tool and automatically configures the MCP server.

npx archyra init --client <tool>

Direct setup for a specific tool

Skip the interactive prompt and directly configure for a specific tool. Valid options: claude, cursor, windsurf.

npx archyra serve

Start the MCP server manually

Starts the MCP server directly. Useful for testing or when running manually instead of through npx.

npx archyra --help

Show help information

Displays all available commands and options.

init Command

The init command configures the MCP server for your AI coding tool.

Options
OptionDescriptionValues
--client <tool>Specify the AI tool to configureclaude, cursor, windsurf
--forceOverwrite existing configurationflag
--helpShow help for init commandflag

Examples

Interactive setup (recommended for first-time users):

npx archyra init

Configure for Claude Code:

npx archyra init --client claude

Configure for Cursor:

npx archyra init --client cursor

Configure for Windsurf:

npx archyra init --client windsurf

serve Command

The serve command starts the MCP server. This is typically called automatically by your AI tool, but can be run manually for testing.

Usage

npx archyra serve

Note: When running manually, the server communicates via stdio. This is mainly useful for debugging. In normal usage, your AI tool will start the server automatically.

MCP Tools Reference

Once the MCP server is running, these tools are available to your AI assistant:

list_components
List all available UI components
ParameterTypeDescription
categorystring (optional)Filter by category: all, loading, processing, creative, auth, chat, ecommerce
get_component
Get detailed information about a specific component
ParameterTypeDescription
namestring (required)Component name (e.g., "LoadingDots", "AiCreating2")
add_component
Get source code and setup instructions to add a component
ParameterTypeDescription
namestring (required)Component name to add
directorystring (optional)Target directory (default: "components")
get_install_command
Get the npm install command for dependencies
ParameterTypeDescription
namestring (required)Component name

Example AI Prompts

Here are some example prompts you can use with your AI assistant:

"List all archyra components"

list_components

"Show me loading indicator options"

list_components (category: loading)

"Get the source code for AuthPage"

get_component

"Add LoadingDots to my components folder"

add_component

"What dependencies does FloatingLogin need?"

get_install_command

"Show me all e-commerce components"

list_components (category: ecommerce)

Environment Variables

VariableDescriptionDefault
DEBUGEnable debug loggingfalse