What is VUP

VUP helps teams ship faster with one consistent way to build apps, guide AI, and add capabilities over time.

What You Get

1) Apps Layer (vup app add)

Start quickly with ready-to-use app templates:

• Frontend: Vue, Nuxt, VitePress
• Backend: Nest
• Multi-platform: UniApp, Capacitor, Electron
• Platform/Tools: Qiankun, WXT, CLI, MCP, Component, Package

2) AI Governance Layer (.agents)

AI is not a black box here. It is a governed delivery system.

• .agents/_core/rules/*: non-negotiable rules for workflow, files, modules, and quality
• .agents/_core/tasks/*: task playbooks for actions such as adding apps, pages, APIs, auth, and releases
• .agents/_core/stacks/*: platform-specific notes loaded only when a task needs them
• External skills: installed and managed outside .agents

Why generated code is more standard:

• Standardized input: explicit rules, skills, and file conventions.
• Standardized process: phased execution, confirmation gates, decision trace.
• Standardized output: consistent structure, naming, and reviewability.

Traditional AI coding vs VUP governance:

Dimension	Generic AI Generation	VUP Governance
Input	Prompt-only, easy to drift	Rules + skills + repo conventions
Process	Opaque steps	Phase/Gate based, auditable checkpoints
Output	Style varies by run	Consistent structure and standards
Team Collaboration	Hard to align	Shared conventions and reusable playbooks

The core is organized by responsibility:

• Rules keep every AI run inside the same boundaries.
• Tasks tell AI how to perform common engineering actions.
• Stacks explain where each platform differs.
• External skills add domain knowledge without modifying the vup core.

3) Packages Layer (vup package add)

Add capabilities after project bootstrap, only when needed:

• @vup/ui / @vup/ui-mobile: desktop/mobile UI abstraction
• @vup/http: shared request foundation and interceptor pipeline
• @vup/mock: MSW-based mock layer for development and testing
• @vup/pwa: shared PWA preset and runtime helpers
• @vup/iconfont: icon asset integration
• @vup/richeditor: rich text capability
• @vup/nest-upload: Nest file upload module

Packages are the actual runtime capabilities. Tasks describe when to add them and how to wire them in, so AI should use @vup/http or @vup/ui from the base instead of inventing parallel implementations.

4) Examples Reference Layer (examples/)

The base repository also provides isolated capability examples:

• examples/mock
• examples/pwa
• examples/qiankun
• examples/ui

These examples are for reference and verification only, and are not treated as official app templates in vup app add. Add them with vup example add when needed.

Why It Works

• Faster kickoff: pick templates and start coding immediately.
• Predictable AI output: rules keep behavior consistent, skills reduce rework.
• Sustainable growth: add packages gradually instead of redesigning early.
• Team alignment: shared standards simplify onboarding and reviews.

Where to Continue

• Quick start and command usage: Getting Started
• AI governance details: AI Governance
• Package strategy: Packages Overview
• Capability examples: Examples Overview
• Templates: Vue, Nuxt, Nest, VitePress, Electron, Capacitor, UniApp, WXT, Qiankun, Component, Package, CLI, MCP
• Packages: PWA, UI, UI Mobile, Iconfont, RichEditor, Nest Upload
• Standards: Format & Style, Husky, Release-it