Cursor rule

1---
2description: "cutcli-cookbook 常用命令速查 — npm / git / gh / wrangler / cutcli"
3globs: "**/*"
4alwaysApply: true
5---
6 
7# 命令速查
8 
9## npm scripts
10 
11```bash
12# 文档站
13npm run docs:dev              # 本地预览 http://localhost:5173
14npm run docs:build            # 输出到 docs/.vitepress/dist/
15npm run docs:preview          # 预览构建产物
16 
17# Lint
18npm run lint                  # 跑全部 lint：cases + commands + links
19npm run lint:cases            # 只校验所有 examples
20npm run lint:cmds             # grep 公开仓有没有裸 cut 命令
21npm run lint:links            # markdown 内部链接可达性
22 
23# 案例脚手架
24npm run new:example my-case   # 在 examples/99-community/<handle>/my-case/ 生成骨架
25 
26# 部署 (CI 自动跑；本地手动也可)
27npm run r2:upload             # 增量上传 dist 到 R2 cutcli-docs
28npm run r2:gc -- --yes        # 删除 R2 中已不在 dist 的孤儿对象（每周一次）
29npm run worker:dev            # 本地起 worker dev server
30npm run worker:deploy         # wrangler deploy 到 docs-cutcli
31npm run deploy                # = docs:build + r2:upload + worker:deploy
32```
33 
34## 案例校验
35 
36```bash
37# 校验单个 case
38node scripts/validate-example.mjs examples/01-hello-caption
39 
40# 校验所有
41node scripts/validate-example.mjs --all
42```
43 
44## docs/reference 同步（来自闭源仓）
45 
46```bash
47# 在闭源仓内
48cd /Users/m007/codes/jy_cli
49 
50# 看会写什么、不实际写
51node scripts/sync-to-cookbook.mjs --dry-run
52 
53# 实际同步（默认输出到 ../cutcli-cookbook/docs/reference/）
54node scripts/sync-to-cookbook.mjs
55 
56# 自定义输出位置
57node scripts/sync-to-cookbook.mjs --out /tmp/sync-test/
58 
59# 跑同步脚本的单元测试
60node scripts/sync.test.mjs
61```
62 
63## git / gh
64 
65```bash
66# 查看状态
67git status -s
68 
69# 提交（遵循 Conventional Commits，详见 commit-flow.mdc）
70git commit -m &quot;feat(examples): add 06-cinematic-title&quot;
71 
72# 推送
73git push
74 
75# 看 CI 跑得怎么样
76gh run list --limit 5
77gh run watch &lt;id&gt;
78gh run view &lt;id&gt; --log-failed | tail -40
79 
80# 手动触发 deploy
81gh workflow run deploy-docs.yml
82 
83# 配 secret
84gh secret set CLOUDFLARE_API_TOKEN --body &quot;$CLOUDFLARE_API_TOKEN&quot;
85gh secret set CLOUDFLARE_ACCOUNT_ID --body &quot;11c47779f0d4c3d0e69ccc6c484dc589&quot;
86 
87# 看 secret 列表
88gh secret list
89 
90# 开 issue
91gh issue create --title &quot;...&quot; --body-file body.md --label good-first-issue
92```
93 
94## Cloudflare wrangler
95 
96> 本地用本仓的 `worker/node_modules/.bin/wrangler`，避免 npx 拉取慢。
97 
98```bash
99WR=worker/node_modules/.bin/wrangler
100 
101# 检查身份
102$WR whoami
103 
104# R2 bucket 操作
105$WR r2 bucket create cutcli-docs
106$WR r2 bucket list
107$WR r2 object put cutcli-docs/&lt;key&gt; --file=&lt;local&gt;
108$WR r2 object delete cutcli-docs/&lt;key&gt;
109 
110# Worker 部署
111cd worker && $WR deploy
112cd worker && $WR tail        # 实时日志
113cd worker && $WR dev         # 本地
114 
115# 看版本
116$WR --version
117```
118 
119## cutcli (跑案例时用)
120 
121```bash
122# 装
123curl -s https://cutcli.com/cli | bash
124 
125# 跑某个案例
126cd examples/01-hello-caption && bash run.sh
127 
128# 命令速查
129cutcli --help
130cutcli docs                      # 离线手册
131cutcli docs &lt;topic&gt;              # 子命令手册
132cutcli docs open                 # 在浏览器打开 docs.cutcli.com
133 
134# 查询素材
135cutcli query text-animations --type in --pretty
136cutcli query stickers --action search --keyword &quot;爱心&quot;
137cutcli query effects --action categories
138cutcli query filters --action search --keyword &quot;复古&quot;
139cutcli query transitions --action search --keyword &quot;叠化&quot;
140```
141 
142## 在线 smoke
143 
144```bash
145# 单页
146curl -s -o /dev/null -w &quot;%{http_code}\n&quot; https://docs.cutcli.com/
147 
148# 全套（部署后跑）
149for p in / /guide/installation /guide/installation.html /reference/cli /cookbook/index /404-test; do
150  code=$(curl -s -o /dev/null -w &quot;%{http_code}&quot; &quot;https://docs.cutcli.com$p&quot;)
151  echo &quot;  $code  $p&quot;
152done
153```
154 
155## 一键全跑
156 
157提交前自检：
158 
159```bash
160npm run lint && npm run docs:build && echo &quot;✓ ready to commit&quot;
161```
162