tdesign-uniapp-cli

CLI tool for querying TDesign UniApp component knowledge and analyzing usage in projects.

All data is bundled offline — no network needed at runtime.

Features

• 📋 Component listing — Browse all TDesign UniApp components by category
• 🔍 Component info — Query props, events, slots, and API details
• 📄 Documentation — Full component docs in markdown format
• 💡 Demo code — Working examples for every component
• 🎨 Design tokens — Component-level CSS variables
• 📝 Changelog — Version history and breaking changes
• 🔧 Environment info — Collect system & dependency snapshots
• 🤖 MCP server — Model Context Protocol integration for AI IDEs

Installation

npm install -g tdesign-uniapp-cli

Quick Start

# List all components
tdesign-uniapp list

# Get component API info
tdesign-uniapp info Button

# Get a working demo
tdesign-uniapp demo Button basic

# View component docs
tdesign-uniapp doc Tabs

# Check design tokens
tdesign-uniapp token Button

# View changelog
tdesign-uniapp changelog 1.0.0 1.5.0

# Collect environment info
tdesign-uniapp env

Global Flags

| Flag | Purpose | |---|---| | --format json\|text\|markdown | Output format (default: text) | | --version <v> | Target a specific TDesign version (e.g. 1.5.0) | | --lang en\|zh | Language (default: en) | | --detail | Include extra fields (description, since, deprecated, FAQ) |

MCP Server

The CLI can also run as an MCP (Model Context Protocol) server for AI IDE integration:

{
  "mcpServers": {
    "tdesign-uniapp": {
      "command": "tdesign-uniapp",
      "args": ["mcp", "--version", "1.5.0"]
    }
  }
}

Development

# Install dependencies
pnpm install

# Build
pnpm build

# Watch mode
pnpm dev

# Run tests
pnpm test

# Type check
pnpm typecheck

# Extract data from TDesign source
pnpm extract

Tech Stack

• TypeScript + Node.js (ESM)
• CLI framework: commander
• Build: tsup
• Tests: vitest
• Node minimum: 18+

License

MIT