Skip to content

Commit 2ffac8c

Browse files
tikazyqMarvin Zhangclaude
authored
chore: rename lean-spec → leanspec / @leanspec/cli (Part of codervisor/leanspec#254) (#7)
Sync to the upstream codebase rename in codervisor/leanspec#254. Substitutions applied across en + zh-Hans content (.mdx / .md / .json / .ts), driven by an ordered ruleset to avoid clobbering things that did NOT rename: - `lean-spec.dev` — domain stays (leanspec.dev is taken) - `lean-spec-docs` — this repo's slug stays - `lean-spec-desktop` — separate repo - `.lean-spec/` — project config directory unchanged Renamed: - GitHub URLs: codervisor/lean-spec → codervisor/leanspec - npm CLI package: lean-spec → @leanspec/cli (anti-typosquatting fallback) - MCP server package: lean-spec (bin) → @leanspec/mcp (separate package) - Bare CLI invocation: `lean-spec <cmd>` → `leanspec <cmd>` (incl. --flags and shell pipes) - MCP config key in JSON examples: "lean-spec" → "leanspec" - Multi-project MCP keys: "lean-spec-projectA" → "leanspec-projectA" - Anchor links: #lean-spec-<cmd> → #leanspec-<cmd> - docusaurus.config.ts projectName + editUrl + footer links - AGENTS.md + footer translations Build verified: `tsc --noEmit` clean, `docusaurus build` clean for both en and zh-Hans (config has `onBrokenLinks: 'throw'`, so any broken internal anchor would have failed the build). 82 files changed. Co-authored-by: Marvin Zhang <tikazyq@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 0a2338e commit 2ffac8c

82 files changed

Lines changed: 1393 additions & 1393 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ Every English `.mdx` file needs a Chinese translation in `i18n/zh-Hans/docusauru
3434
Never translate these terms - they are technical concepts with established English usage:
3535

3636
- **Core terms**: Spec, LeanSpec, CLI, Token, README, frontmatter, MCP
37-
- **Commands**: `lean-spec create`, `lean-spec update`, `lean-spec board`, etc.
37+
- **Commands**: `leanspec create`, `leanspec update`, `leanspec board`, etc.
3838
- **Status values**: `planned`, `in-progress`, `complete`, `archived`
3939
- **File types**: `.md`, `.mdx`, `.json`, `.yaml`
4040
- **Technical terms**: SDD (Spec-Driven Development), API, JWT, URL, JSON
4141

4242
**Examples:**
4343
```markdown
44-
✅ "使用 `lean-spec create` 创建新 Spec"
44+
✅ "使用 `leanspec create` 创建新 Spec"
4545
❌ "使用 `精益规范创建` 创建新规格说明"
4646

4747
✅ "Spec 文件使用 Markdown 格式"
@@ -164,8 +164,8 @@ Balance readability with precision:
164164
✅ "LeanSpec 是一种轻量级的规格驱动开发 (SDD) 方法论"
165165
❌ "LeanSpec 是一个轻量级规范驱动的开发方法"
166166

167-
✅ "使用 `lean-spec board` 查看 Spec 看板"
168-
❌ "使用 `lean-spec board` 查看规格说明看板"
167+
✅ "使用 `leanspec board` 查看 Spec 看板"
168+
❌ "使用 `leanspec board` 查看规格说明看板"
169169
```
170170

171171
**Technical Explanations:**
@@ -183,7 +183,7 @@ Balance readability with precision:
183183
Before committing Chinese translations, verify:
184184

185185
- [ ] All "Spec" references use "Spec" (not "规格" or "规范")
186-
- [ ] All commands remain in English (e.g., `lean-spec create`)
186+
- [ ] All commands remain in English (e.g., `leanspec create`)
187187
- [ ] Technical terms have English references on first use
188188
- [ ] Chinese text reads naturally (not word-by-word translation)
189189
- [ ] Full-width punctuation used consistently

blog/2025-11-10-ai-agent-performance.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ We built LeanSpec using LeanSpec itself—the ultimate test of whether this meth
154154
- Full-featured CLI with 15+ commands
155155
- MCP server for Cursor, GitHub Copilot integration
156156
- Documentation site with comprehensive guides
157-
- [60+ specs](https://github.com/codervisor/lean-spec/tree/main/specs) written and implemented with AI agents
157+
- [60+ specs](https://github.com/codervisor/leanspec/tree/main/specs) written and implemented with AI agents
158158

159159
**Then we violated our own principles**: Some specs grew to 1,166 lines. We hit the exact problems we were solving:
160160
- AI agents started corrupting specs during edits
@@ -212,21 +212,21 @@ CLI commands help you detect and fix context issues:
212212

213213
```bash
214214
# Install
215-
npm install -g lean-spec
215+
npm install -g @leanspec/cli
216216

217217
# Initialize in your project
218218
cd your-project
219-
lean-spec init
219+
leanspec init
220220

221221
# Detect issues
222-
lean-spec validate # Check for problems
223-
lean-spec complexity <spec> # Analyze size/structure
222+
leanspec validate # Check for problems
223+
leanspec complexity <spec> # Analyze size/structure
224224

225225
# Fix issues
226-
lean-spec split <spec> # Guided splitting workflow
226+
leanspec split <spec> # Guided splitting workflow
227227

228228
# Track progress
229-
lean-spec board # Kanban view of all specs
229+
leanspec board # Kanban view of all specs
230230
```
231231

232232
### Start Simple, Grow as Needed
@@ -242,10 +242,10 @@ The structure adapts to your needs—you never add complexity "just in case."
242242
### Try It Today
243243

244244
```bash
245-
npm install -g lean-spec
245+
npm install -g @leanspec/cli
246246
cd your-project
247-
lean-spec init
248-
lean-spec create user-authentication
247+
leanspec init
248+
leanspec create user-authentication
249249
```
250250

251251
Your AI coding assistant will thank you.
@@ -269,7 +269,7 @@ LeanSpec is a context engineering methodology for human-AI collaboration on soft
269269
---
270270

271271
**Learn more**:
272-
- GitHub: [github.com/codervisor/lean-spec](https://github.com/codervisor/lean-spec)
272+
- GitHub: [github.com/codervisor/leanspec](https://github.com/codervisor/leanspec)
273273
- Docs: [lean-spec.dev](https://lean-spec.dev)
274274
- Research: [Context Engineering Guide](/docs/advanced/context-engineering)
275275

blog/2025-11-25-recent-updates.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ The best way to understand LeanSpec is to use it. That's why we built **example
1919

2020
```bash
2121
# See what's available
22-
npx lean-spec examples
22+
npx -p @leanspec/cli leanspec examples
2323

2424
# Scaffold an example project
25-
npx lean-spec init --example dark-theme
25+
npx -p @leanspec/cli leanspec init --example dark-theme
2626
cd dark-theme
2727
npm install
2828
npm start
@@ -68,7 +68,7 @@ We extracted `@leanspec/mcp` into its own npm package. Setup is now cleaner:
6868
```json
6969
{
7070
"mcpServers": {
71-
"lean-spec": {
71+
"leanspec": {
7272
"command": "npx",
7373
"args": ["@leanspec/mcp"]
7474
}
@@ -84,13 +84,13 @@ New commands make relationship management clearer:
8484

8585
```bash
8686
# Link specs with clear dependencies
87-
lean-spec link feature-123 --depends-on auth-system
87+
leanspec link feature-123 --depends-on auth-system
8888

8989
# See the full dependency graph
90-
lean-spec deps feature-123
90+
leanspec deps feature-123
9191

9292
# Remove relationships
93-
lean-spec unlink feature-123 --from auth-system
93+
leanspec unlink feature-123 --from auth-system
9494
```
9595

9696
Better validation catches circular dependencies before they cause problems.
@@ -101,13 +101,13 @@ Every major command now supports `--json` for programmatic use:
101101

102102
```bash
103103
# Integrate with dashboards
104-
lean-spec board --json | jq '.columns[] | select(.status=="in-progress")'
104+
leanspec board --json | jq '.columns[] | select(.status=="in-progress")'
105105

106106
# Build custom workflows
107-
lean-spec list --json --status=complete | jq -r '.[] | .name'
107+
leanspec list --json --status=complete | jq -r '.[] | .name'
108108

109109
# Export for reporting
110-
lean-spec timeline --json > project-timeline.json
110+
leanspec timeline --json > project-timeline.json
111111
```
112112

113113
Use LeanSpec data in your CI/CD pipelines, project dashboards, or custom tooling.
@@ -149,7 +149,7 @@ Read [Why Your AI Agent Gets Dumber with Large Specs](/blog/ai-agent-performance
149149
### 2. Spin Up an Example (2 minutes)
150150

151151
```bash
152-
npx lean-spec init --example dark-theme
152+
npx -p @leanspec/cli leanspec init --example dark-theme
153153
cd dark-theme
154154
npm install
155155
```
@@ -171,8 +171,8 @@ Open the [Your First Spec with AI](/docs/tutorials/first-spec-with-ai) tutorial.
171171

172172
```bash
173173
cd your-existing-project
174-
npx lean-spec init
175-
lean-spec create user-authentication
174+
npx -p @leanspec/cli leanspec init
175+
leanspec create user-authentication
176176
```
177177

178178
Now apply what you learned. Start simple (status + created), add structure as needed (tags, priority, custom fields).
@@ -193,16 +193,16 @@ We're focused on making LeanSpec work seamlessly with more AI tools and developm
193193
- **Project management integrations** - Jira, Linear, and GitHub Projects sync
194194
- **More example projects** - Backend APIs, mobile apps, infrastructure
195195

196-
**Feedback shapes the roadmap**. What would make LeanSpec more useful for your workflow? [Open an issue](https://github.com/codervisor/lean-spec/issues) or [join the discussion](https://github.com/codervisor/lean-spec/discussions).
196+
**Feedback shapes the roadmap**. What would make LeanSpec more useful for your workflow? [Open an issue](https://github.com/codervisor/leanspec/issues) or [join the discussion](https://github.com/codervisor/leanspec/discussions).
197197

198198
## Try It Today
199199

200200
```bash
201201
# Install globally
202-
npm install -g lean-spec
202+
npm install -g @leanspec/cli
203203

204204
# Or use npx for one-off commands
205-
npx lean-spec init --example dark-theme
205+
npx -p @leanspec/cli leanspec init --example dark-theme
206206
```
207207

208208
The fastest way to learn is to build. Pick an example, follow a tutorial, see how AI-assisted spec-driven development changes your workflow.
@@ -211,9 +211,9 @@ The fastest way to learn is to build. Pick an example, follow a tutorial, see ho
211211

212212
**Links**:
213213
- [Documentation](https://lean-spec.dev)
214-
- [GitHub Repository](https://github.com/codervisor/lean-spec)
214+
- [GitHub Repository](https://github.com/codervisor/leanspec)
215215
- [Example Projects](https://lean-spec.dev/docs/tutorials/first-spec-with-ai#quick-start)
216216
- [Getting Started Guide](https://lean-spec.dev/docs/guide/getting-started)
217217
- [Full Tutorial Collection](https://lean-spec.dev/docs/tutorials/first-spec-with-ai)
218218

219-
**Changelog**: See [CHANGELOG.md](https://github.com/codervisor/lean-spec/blob/main/CHANGELOG.md) for detailed version history.
219+
**Changelog**: See [CHANGELOG.md](https://github.com/codervisor/leanspec/blob/main/CHANGELOG.md) for detailed version history.

docs/advanced/ai-assisted-spec-writing.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Once refined, the spec becomes a **checkpoint** - a formalized agreement between
145145
**Mark as checkpoint:**
146146
- Save the spec file
147147
- Mark status as "planned" or "in-progress"
148-
- Use `lean-spec create` or update frontmatter
148+
- Use `leanspec create` or update frontmatter
149149
- Reference spec in commits and PRs
150150

151151
**The spec now serves as:**
@@ -412,7 +412,7 @@ Specs should capture intent and constraints, not prescribe every implementation
412412

413413
### DON'T: Forget to Update Status
414414

415-
Use `lean-spec update <spec> --status <status>` to track progress. AI can help draft, but you manage lifecycle.
415+
Use `leanspec update <spec> --status <status>` to track progress. AI can help draft, but you manage lifecycle.
416416

417417
## Common Pitfalls
418418

0 commit comments

Comments
 (0)