Complete technical reference for UX Master.
CLI commands, MCP server, Harvester v4, and API integration.
CLI Reference
Install and control UX Master from your terminal.
# Install UX-Master CLI
pip install uxmaster-cli
# Or with pipx (recommended)
pipx install uxmaster-cli# Install for Claude
uxm init --ai claude
# Install for all platforms
uxm init --ai all# Search UX Laws
uxm search "mobile touch" --domain ux-laws
# Generate design system
uxm search "fintech dashboard" --design-system# Validate HTML file
uxm validate index.html --suite mobile
# Validate URL
uxm validate https://example.com --url# Extract design system
uxm extract https://stripe.com
# Export to Figma
uxm extract https://linear.app --figmaMCP Server
Connect UX Master to Claude, Cursor, and other AI assistants via MCP.
Model Context Protocol (MCP) allows AI assistants to use UX Master tools directly. Your AI can search UX Laws, validate designs, and extract design systems automatically.
# Start the server
uxm mcp start
# Start with custom port
uxm mcp start --port 8080
# Check status
uxm mcp status{
"mcpServers": {
"ux-master": {
"command": "python",
"args": ["-m", "mcp.server"],
"env": {
"PORT": "3000"
}
}
}
}{
"mcpServers": {
"ux-master": {
"url": "http://localhost:3000"
}
}
}Harvester v4
Extract complete design systems from any website automatically.
# Single URL harvest
python3 scripts/harvester_browser.py --url https://example.com
# Multi-page crawl
python3 scripts/harvester_browser.py --url https://example.com --crawl --max-pages 10
# Full workflow: Extract + Index + Generate
python3 scripts/harvester_cli.py quick https://example.com --framework semiFull documentation on browser automation, AI visual analysis, and component generation.
REST API
Programmatic access to all UX Master features.
/mcp/v1/tools/search_ux_laws
Search 48 UX Laws for psychology-driven design principles.
/mcp/v1/tools/validate_design
Validate UI code against 37 Design Tests.
/mcp/v1/tools/extract_design_system
Extract design system from any website URL.
/mcp/v1/tools/generate_design_system
Generate design system from description.
Integrations
Generate AI prompts for Google Stitch. Create consistent AI-generated designs.
View guide →Vue 3 component templates. Nuxt UI integration patterns.
Coming soonSvelteKit integration. Store patterns and transitions.
Coming soonCross-platform mobile components. Native styling patterns.
Coming soonFound a bug? Need help with integration? Join our community or open an issue on GitHub.