repoctl 5.1.1 → 5.3.0

package/README.md

@@ -1,126 +1,62 @@
 # repoctl
 
-Package name: `repoctl`. Recommended command: `repo`.
+English | [简体中文](README.zh-CN.md)
+
+`repoctl` is the recommended package for the repoctl CLI. The package name is `repoctl`; the primary executable is `repo`.
 
 ## Install
 
-```sh
+```bash
 pnpm add -D repoctl
 ```
 
-## Quick Start
+## Start with an existing workspace
 
-```sh
+```bash
 pnpm exec repo init
 pnpm exec repo doctor
-pnpm exec repo doctor --json
-pnpm exec repo doctor --json --out reports/doctor.json
 pnpm exec repo templates
 pnpm exec repo new my-package
 pnpm exec repo check
-pnpm exec repo check --dry-run
-pnpm exec repo env info
 ```
 
-Inside generated repos, the same workflow is available as conflict-free `repo:*` root scripts:
-
-```sh
-pnpm run repo:init
-pnpm run repo:doctor -- --json
-pnpm run repo:new -- my-package
-pnpm run repo:check
-```
-
-## What Each Command Is For
-
-- `repo init`: initialize the workspace with the recommended metadata and tooling defaults.
-- `repo doctor`: diagnose whether the current repo is ready to use.
-- `repo templates`: list the built-in package/app templates and their target folders.
-- `repo new`: create a new package or app.
-- `repo check`: run the recommended local verification flow.
-- `repo upgrade`: sync the latest standard assets and scripts from the template.
-
-`repo init` is safe to run in an existing pnpm workspace. By default it creates missing root files, appends missing workspace patterns, and skips existing README/tooling files; use `--force` or `--overwrite` when you explicitly want managed files rewritten. Use `--yes` in CI.
-
-`repo upgrade` is also CI-safe. In a non-TTY process it will not prompt; changed files are skipped unless you pass `--yes` or `--overwrite`. Use `--no-overwrite` when automation must preserve every changed file.
+Generated workspaces also expose conflict-free root scripts such as `repo:init`, `repo:doctor`, `repo:new`, and `repo:check`.
 
-`repo doctor` is intentionally lightweight. It checks root workspace files, Node version compatibility, CLI dependency presence, recommended `repo:*` root scripts, stale `monorepo.config.ts` files, workspace pattern coverage, legacy local tooling imports, and whether Husky plus lint-staged are both wired. Use `repo doctor --json --out reports/doctor.json` or `pnpm run repo:doctor -- --json` when automation needs a persisted report.
-Use `repo check --dry-run` or `repo check --json --out reports/check-plan.json` when automation needs to inspect the verification plan before running it.
+## Common workflows
 
-## Common Commands
-
-```sh
-# sync repo standards
-pnpm exec repo upgrade
+```bash
+# inspect or update a workspace
+pnpm exec repo doctor --json
 pnpm exec repo upgrade --yes
-pnpm exec repo upgrade --no-overwrite
 
-# create a specific template without extra prompts
-pnpm exec repo new dashboard --template vue-hono
-pnpm exec repo new dashboard --template vue-hono --dry-run
+# preview creation without writing files
 pnpm exec repo new dashboard --template vue-hono --json
-pnpm exec repo new dashboard --template vue-hono --json --out plans/dashboard.json
-# invalid template keys fail with a suggestion instead of falling back silently
 
-# discover available templates
-pnpm exec repo templates
-pnpm exec repo templates tsdown
-pnpm exec repo templates --category library
-pnpm exec repo templates --check
-pnpm exec repo templates --check --json
-pnpm exec repo templates --json
-pnpm exec repo templates --markdown
-pnpm exec repo templates tsdown --markdown
-pnpm exec repo templates --markdown --out docs/templates.md
-
-# advanced workspace upgrade
-pnpm exec repo ws up
-
-# inspect verification routing
+# inspect verification before running it
 pnpm exec repo check --dry-run
-pnpm exec repo check --json --out reports/check-plan.json
-
-# collect environment info for debugging
-pnpm exec repo env info
-pnpm exec repo env info --json --out reports/env.json
-pnpm exec repo env snapshot --json --out reports/snapshot.json
-
-# inspect workspace packages
-pnpm exec repo ws ls
-pnpm exec repo ws ls --json --include-private
-pnpm exec repo ws ls --json --out reports/workspaces.json
+pnpm exec repo check --full
 
-# generate tooling configs
-pnpm exec repo tg init --all
+# collect a support bundle
+pnpm exec repo env support --json --redact --out reports/support.json
 ```
 
-## Config
+## Language
 
-Create `repoctl.config.ts` in the workspace root to customize defaults.
+Output is English by default. Use `--lang zh-CN` or `REPOCTL_LANG=zh-CN` for Simplified Chinese.
 
-```ts
-import { defineMonorepoConfig } from 'repoctl'
-
-export default defineMonorepoConfig({
-  commands: {
-    init: {
-      preset: 'standard',
-    },
-    create: {
-      defaultTemplate: 'tsdown',
-    },
-  },
-})
+```bash
+pnpm exec repo --lang zh-CN doctor
+REPOCTL_LANG=zh-CN pnpm exec repo check --dry-run
 ```
 
-When `commands.create.defaultTemplate` is set, `repo new foo` creates the package directly and places it under the conventional base directory inferred from the template, such as `packages/foo` or `apps/foo`.
-
-Use `repoctl.config.ts`. `monorepo.config.ts` is no longer loaded at runtime.
+## Advanced APIs
 
-## Performance Notes
+`repoctl` re-exports the programmatic APIs from `@icebreakers/monorepo`. Tooling wrappers are available from `repoctl/tooling`.
 
-The CLI keeps startup lightweight by registering the command tree first and loading each command implementation only when that action runs. Workspace discovery also uses an in-process cache, so repeated checks inside one command reuse the same `pnpm-workspace.yaml` and package scan results.
+```ts
+import { defineEslintConfig } from 'repoctl/tooling'
 
-## Advanced Usage
+export default await defineEslintConfig()
+```
 
-If you need the lower-level API and tooling wrappers, see `@icebreakers/monorepo`.
+Documentation: https://repo.icebreaker.top

package/README.zh-CN.md

@@ -0,0 +1,44 @@
+# repoctl
+
+[English](README.md) | 简体中文
+
+`repoctl` 是 repoctl CLI 的推荐安装包。包名为 `repoctl`，主要命令为 `repo`。
+
+## 安装
+
+```bash
+pnpm add -D repoctl
+```
+
+## 接入已有工作区
+
+```bash
+pnpm exec repo init
+pnpm exec repo doctor
+pnpm exec repo templates
+pnpm exec repo new my-package
+pnpm exec repo check
+```
+
+生成后的工作区还会提供 `repo:init`、`repo:doctor`、`repo:new` 和 `repo:check` 等无冲突根脚本。
+
+## 常用工作流
+
+```bash
+pnpm exec repo doctor --json
+pnpm exec repo upgrade --yes
+pnpm exec repo new dashboard --template vue-hono --json
+pnpm exec repo check --dry-run
+pnpm exec repo check --full
+pnpm exec repo env support --json --redact --out reports/support.json
+```
+
+## 语言
+
+默认输出英文。使用 `--lang zh-CN` 或 `REPOCTL_LANG=zh-CN` 切换为简体中文。
+
+## 高级 API
+
+`repoctl` 会重新导出 `@icebreakers/monorepo` 的程序化 API，工程配置 wrapper 位于 `repoctl/tooling`。
+
+文档：https://repo.icebreaker.top

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "repoctl",
   "type": "module",
-  "version": "5.1.1",
-  "description": "Default task-first CLI for pnpm and Turbo monorepo setup and maintenance",
+  "version": "5.3.0",
+  "description": "Task-first CLI for initializing, maintaining, validating, and releasing pnpm and Turborepo monorepos",
   "author": "ice breaker <hi@sonofmagic.top>",
   "license": "MIT",
   "homepage": "https://repo.icebreaker.top",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sonofmagic/monorepo-template.git",
+    "url": "git+https://github.com/sonofmagic/repoctl.git",
     "directory": "packages/repoctl"
   },
   "bugs": {
-    "url": "https://github.com/sonofmagic/monorepo-template/issues"
+    "url": "https://github.com/sonofmagic/repoctl/issues"
   },
   "keywords": [
     "repoctl",
@@ -88,7 +88,7 @@
     }
   },
   "dependencies": {
-    "@icebreakers/monorepo": "5.1.1"
+    "@icebreakers/monorepo": "5.3.0"
   },
   "scripts": {
     "dev": "tsdown --tsconfig tsconfig.src.json --watch --sourcemap",