lean-spec 0.2.9-dev.20251205030455 → 0.2.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +120 -0
  2. package/dist/{chunk-BJHJ6IUO.js → chunk-KTNU4LUR.js} +1096 -827
  3. package/dist/chunk-KTNU4LUR.js.map +1 -0
  4. package/dist/cli.js +1 -1
  5. package/dist/mcp-server.js +1 -1
  6. package/package.json +2 -2
  7. package/dist/chunk-BJHJ6IUO.js.map +0 -1
package/README.md ADDED
@@ -0,0 +1,120 @@
1
+ # LeanSpec
2
+
3
+ <p align="center">
4
+ <img src="https://github.com/codervisor/lean-spec-docs/blob/main/static/img/logo-with-bg.svg" alt="LeanSpec Logo" width="120" height="120">
5
+ </p>
6
+
7
+ <p align="center">
8
+ <a href="https://github.com/codervisor/lean-spec/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/codervisor/lean-spec/ci.yml?branch=main" alt="CI Status"></a>
9
+ <a href="https://www.npmjs.com/package/lean-spec"><img src="https://img.shields.io/npm/v/lean-spec.svg" alt="npm version"></a>
10
+ <a href="https://www.npmjs.com/package/lean-spec"><img src="https://img.shields.io/npm/dm/lean-spec.svg" alt="npm downloads"></a>
11
+ <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
12
+ </p>
13
+
14
+ <p align="center">
15
+ <a href="https://www.lean-spec.dev"><strong>Documentation</strong></a>
16
+ •
17
+ <a href="https://www.lean-spec.dev/zh-Hans/docs/guide/"><strong>中文文档</strong></a>
18
+ •
19
+ <a href="https://web.lean-spec.dev"><strong>Live Examples</strong></a>
20
+ •
21
+ <a href="https://www.lean-spec.dev/docs/tutorials/first-spec-with-ai"><strong>Tutorials</strong></a>
22
+ </p>
23
+
24
+ ---
25
+
26
+ **Ship faster with higher quality. Lean specs that both humans and AI understand.**
27
+
28
+ LeanSpec brings agile principles to SDD (Spec-Driven Development)—small, focused documents (<2,000 tokens) that keep you and your AI aligned.
29
+
30
+ ---
31
+
32
+ ## Quick Start
33
+
34
+ ```bash
35
+ # Try with a tutorial project
36
+ npx lean-spec init --example dark-theme
37
+ cd dark-theme && npm install && npm start
38
+
39
+ # Or add to your existing project
40
+ npm install -g lean-spec && lean-spec init
41
+ ```
42
+
43
+ **Visualize your project:**
44
+
45
+ ```bash
46
+ lean-spec board # Kanban view
47
+ lean-spec stats # Project metrics
48
+ lean-spec ui # Web UI at localhost:3000
49
+ ```
50
+
51
+ **Next:** [Your First Spec with AI](https://www.lean-spec.dev/docs/tutorials/first-spec-with-ai) (10 min tutorial)
52
+
53
+ ---
54
+
55
+ ## Why LeanSpec?
56
+
57
+ **High velocity + High quality.** Other SDD frameworks add process overhead (multi-step workflows, rigid templates). Vibe coding is fast but chaotic (no shared understanding). LeanSpec hits the sweet spot:
58
+
59
+ - **Fast iteration** - Living documents that grow with your code
60
+ - **AI performance** - Small specs = better AI output (context rot is real)
61
+ - **Always current** - Lightweight enough that you actually update them
62
+
63
+ 📖 [Compare with Spec Kit, OpenSpec, Kiro →](https://www.lean-spec.dev/docs/guide/why-leanspec)
64
+
65
+ ---
66
+
67
+ ## AI Integration
68
+
69
+ Works with any AI coding assistant via MCP or CLI:
70
+
71
+ ```json
72
+ {
73
+ "mcpServers": {
74
+ "lean-spec": { "command": "npx", "args": ["@leanspec/mcp"] }
75
+ }
76
+ }
77
+ ```
78
+
79
+ **Compatible with:** VS Code Copilot, Cursor, Windsurf, Claude Code, Gemini CLI, and more.
80
+
81
+ 📖 [Full AI integration guide →](https://www.lean-spec.dev/docs/guide/usage/ai-coding-workflow)
82
+
83
+ ---
84
+
85
+ ## Features
86
+
87
+ | Feature | Description |
88
+ |---------|-------------|
89
+ | **📊 Kanban Board** | `lean-spec board` - visual project tracking |
90
+ | **🔍 Smart Search** | `lean-spec search` - find specs by content or metadata |
91
+ | **🔗 Dependencies** | Track spec relationships with `depends_on` and `related` |
92
+ | **🎨 Web UI** | `lean-spec ui` - browser-based dashboard |
93
+ | **📈 Project Stats** | `lean-spec stats` - health metrics and bottleneck detection |
94
+ | **🤖 AI-Native** | MCP server + CLI for AI assistants |
95
+
96
+ <p align="center">
97
+ <img src="https://github.com/codervisor/lean-spec-docs/blob/main/static/img/ui/ui-board-view.png" alt="Kanban Board View" width="800">
98
+ </p>
99
+
100
+ ---
101
+
102
+ ## Documentation
103
+
104
+ 📖 [Full Documentation](https://www.lean-spec.dev) · [CLI Reference](https://www.lean-spec.dev/docs/reference/cli) · [First Principles](https://www.lean-spec.dev/docs/advanced/first-principles) · [FAQ](https://www.lean-spec.dev/docs/faq) · [中文文档](https://www.lean-spec.dev/zh-Hans/)
105
+
106
+ ## Community
107
+
108
+ 💬 [Discussions](https://github.com/codervisor/lean-spec/discussions) · 🐛 [Issues](https://github.com/codervisor/lean-spec/issues) · 🤝 [Contributing](CONTRIBUTING.md) · 📋 [Changelog](CHANGELOG.md) · 📄 [LICENSE](LICENSE)
109
+
110
+ ---
111
+
112
+ ### Contact Me | 联系我
113
+
114
+ If you find LeanSpec helpful, feel free to add me on WeChat (note "LeanSpec") to join the discussion group.
115
+
116
+ 如果您觉得 LeanSpec 对您有帮助，欢迎添加微信（备注 "LeanSpec"）加入交流群。
117
+
118
+ <p align="center">
119
+ <img src="https://github.com/codervisor/lean-spec-docs/blob/main/static/img/qr-code.png" alt="WeChat Contact | 微信联系" height="280">
120
+ </p>