Skip to content

Commit 182ea11

Browse files
authored
Merge pull request #120 from TrueNine/codex/fix-release-cli-shell-binary
Update release workflow to source native modules from sdk and sync Cargo lock versions
2 parents 038d1c2 + 86e2a67 commit 182ea11

Some content is hidden

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

49 files changed

+805
-802
lines changed

.github/actions/setup-node-pnpm/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ runs:
2727
using: composite
2828
steps:
2929
- name: Setup pnpm
30-
uses: pnpm/action-setup@v4
30+
uses: pnpm/action-setup@v5
3131
with:
3232
version: ${{ inputs.pnpm-version }}
3333

doc/components/package-manager-tabs.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export function PackageManagerTabs({
8585
>
8686
{tab.label}
8787
{tab.id === recommendedManager
88-
? <span className="docs-package-manager-tab-badge">推荐</span>
88+
? <span className="docs-package-manager-tab-badge">Recommended</span>
8989
: null}
9090
</button>
9191
)

doc/content/_meta.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
export default {
22
'index': {
3-
title: '文档总览'
3+
title: 'Overview'
44
},
55
'quick-guide': {
6-
title: '快速指引'
6+
title: 'Quick Guide'
77
},
88
'cli': {
99
title: 'CLI'
@@ -18,9 +18,9 @@ export default {
1818
title: 'GUI'
1919
},
2020
'technical-details': {
21-
title: '技术细节'
21+
title: 'Technical Details'
2222
},
2323
'design-rationale': {
24-
title: '设计初衷'
24+
title: 'Design Rationale'
2525
}
2626
}

doc/content/cli/_meta.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
export default {
2-
'index': '概览',
3-
'install': '安装与前提',
4-
'workspace-setup': '项目与 aindex',
5-
'first-sync': '第一次同步',
6-
'migration': '从旧文档迁移',
7-
'cli-commands': 'CLI 命令',
8-
'dry-run-and-clean': 'dry-run clean',
2+
'index': 'Overview',
3+
'install': 'Installation and Requirements',
4+
'workspace-setup': 'Workspace and aindex',
5+
'first-sync': 'First Sync',
6+
'migration': 'Migrating from Older Docs',
7+
'cli-commands': 'CLI Commands',
8+
'dry-run-and-clean': 'dry-run and clean',
99
'plugin-config': 'plugin.config.ts',
1010
'schema': 'JSON Schema',
11-
'output-scopes': '输出范围',
11+
'output-scopes': 'Output Scopes',
1212
'frontmatter': 'Front Matter',
13-
'cleanup-protection': '清理保护',
14-
'supported-outputs': '支持的输出目标',
15-
'troubleshooting': '排障',
16-
'upgrade-notes': '升级说明'
13+
'cleanup-protection': 'Cleanup Protection',
14+
'supported-outputs': 'Supported Outputs',
15+
'troubleshooting': 'Troubleshooting',
16+
'upgrade-notes': 'Upgrade Notes'
1717
}

doc/content/cli/cleanup-protection.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
---
2-
title: 清理保护
3-
description: 说明 cleanupProtection 规则如何避免 clean 命令误删不该删除的内容。
4-
sidebarTitle: 清理保护
2+
title: Cleanup Protection
3+
description: Explains how cleanupProtection rules keep the clean command from deleting files that should not be removed.
4+
sidebarTitle: Cleanup Protection
55
status: stable
66
---
77

8-
# 清理保护
8+
# Cleanup Protection
99

10-
`clean` 不是无脑删文件,所以 `cleanupProtection` 也不是可有可无的附属字段。
10+
`clean` is not a brainless file-deletion command, so `cleanupProtection` is not an optional afterthought.
1111

12-
## 规则结构
12+
## Rule Structure
1313

14-
每条保护规则支持这些字段:
14+
Each protection rule supports these fields:
1515

16-
| 字段 | 必填 | 说明 |
16+
| Field | Required | Description |
1717
| --- | --- | --- |
18-
| `path` | | 目标路径或 glob |
19-
| `protectionMode` | | `direct` `recursive` |
20-
| `matcher` | | `path` `glob` |
21-
| `reason` | | 写明这条保护存在的原因 |
18+
| `path` | Yes | Target path or glob |
19+
| `protectionMode` | Yes | `direct` or `recursive` |
20+
| `matcher` | No | `path` or `glob` |
21+
| `reason` | No | Why this protection rule exists |
2222

23-
## 语义
23+
## Semantics
2424

25-
- `direct`:只保护这一个目标。
26-
- `recursive`:保护这一路径下的整棵子树。
25+
- `direct`: protect only this exact target.
26+
- `recursive`: protect the entire subtree under this path.
2727

28-
## 什么时候必须配
28+
## When You Must Configure It
2929

30-
如果你的输出目录旁边混放了:
30+
If your output directories are mixed with:
3131

32-
- 手写文件
33-
- 其他工具生成但不属于 tnmsc 的文件
34-
- 临时人工补丁
32+
- hand-written files
33+
- files generated by other tools that are not owned by tnmsc
34+
- temporary manual patches
3535

36-
那么在启用 `clean` 前最好先加保护规则,否则你迟早会把不该删的内容一起带走。
36+
then add protection rules before enabling `clean`, or sooner or later you will delete things that should have stayed.
3737

38-
## 推荐写法
38+
## Recommended Shape
3939

4040
```json
4141
{
@@ -45,7 +45,7 @@ status: stable
4545
"path": ".cursor/local-notes",
4646
"protectionMode": "recursive",
4747
"matcher": "path",
48-
"reason": "人工维护,不属于 tnmsc 输出"
48+
"reason": "Maintained manually and not owned by tnmsc outputs"
4949
}
5050
]
5151
}

doc/content/cli/cli-commands.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
2-
title: CLI 命令
3-
description: 基于当前 tnmsc --help 输出整理的命令与行为说明。
4-
sidebarTitle: CLI 命令
2+
title: CLI Commands
3+
description: Summarizes the commands and behavior currently exposed by tnmsc --help.
4+
sidebarTitle: CLI Commands
55
status: stable
66
---
77

8-
# CLI 命令
8+
# CLI Commands
99

10-
当前 `tnmsc --help` 暴露的命令是:
10+
The commands currently exposed by `tnmsc --help` are:
1111

12-
| 命令 | 说明 |
12+
| Command | Description |
1313
| --- | --- |
14-
| `tnmsc` | 执行默认同步管线 |
15-
| `tnmsc help` | 查看帮助 |
16-
| `tnmsc version` | 查看版本 |
17-
| `tnmsc init` | 已废弃,不再初始化 aindex |
18-
| `tnmsc dry-run` | 预览会写出的文件 |
19-
| `tnmsc clean` | 删除已生成的输出文件,并继续清理 project 源码树中的空目录 |
20-
| `tnmsc clean --dry-run` | 预览会清理什么,包括后续会被回收的空目录 |
21-
| `tnmsc config key=value` | 修改全局配置 |
14+
| `tnmsc` | Run the default sync pipeline |
15+
| `tnmsc help` | Show help |
16+
| `tnmsc version` | Show the version |
17+
| `tnmsc init` | Deprecated and no longer initializes aindex |
18+
| `tnmsc dry-run` | Preview the files that would be written |
19+
| `tnmsc clean` | Delete generated outputs and continue cleaning empty directories from the project source tree |
20+
| `tnmsc clean --dry-run` | Preview what would be cleaned, including empty directories that would be swept afterward |
21+
| `tnmsc config key=value` | Change global config |
2222

23-
## 关键结论
23+
## Key Takeaways
2424

25-
### `init` 已经不应该出现在新流程里
25+
### `init` Should No Longer Appear in New Workflows
2626

27-
当前实现明确把它视为 deprecated,因此新文档不会再把它写成推荐入口。
27+
The current implementation treats it as deprecated, so new docs no longer present it as a recommended entrypoint.
2828

29-
### `config` 只能改一组白名单键
29+
### `config` Can Only Change a Whitelisted Set of Keys
3030

31-
当前 `ConfigCommand` 允许的键包括:
31+
The current `ConfigCommand` allows these keys:
3232

3333
- `workspaceDir`
3434
- `aindex.skills.src/dist`
@@ -42,17 +42,17 @@ status: stable
4242
- `aindex.arch.src/dist`
4343
- `logLevel`
4444

45-
### `logLevel` 也有严格枚举
45+
### `logLevel` Is Also Strictly Enumerated
4646

47-
只能是:
47+
It can only be:
4848

4949
```text
5050
trace / debug / info / warn / error
5151
```
5252

53-
## 推荐操作习惯
53+
## Recommended Habits
5454

55-
1. 新环境先 `tnmsc help`
56-
2. 写出前先 `tnmsc dry-run`
57-
3. 清理前先 `tnmsc clean --dry-run`
58-
4. 真要改全局配置时,用 `tnmsc config`,不要手写出一份和 Schema 漂移的 JSON
55+
1. Run `tnmsc help` first in a new environment.
56+
2. Run `tnmsc dry-run` before writing outputs.
57+
3. Run `tnmsc clean --dry-run` before cleanup.
58+
4. If you really need to change global config, use `tnmsc config` instead of hand-editing JSON that can drift from the schema.
Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
---
2-
title: dry-run clean
3-
description: 说明 tnmsc 如何先预览输出,再执行清理,并配合 cleanupProtection 控制风险。
4-
sidebarTitle: dry-run clean
2+
title: dry-run and clean
3+
description: Explains how tnmsc previews outputs, then performs cleanup, with cleanupProtection used to control risk.
4+
sidebarTitle: dry-run and clean
55
status: stable
66
---
77

8-
# dry-run clean
8+
# dry-run and clean
99

10-
## `dry-run` 的职责
10+
## What `dry-run` Does
1111

12-
`tnmsc dry-run` 用来预览当前执行会写出哪些文件与目录。它适合在这些场景先跑一遍:
12+
`tnmsc dry-run` previews the files and directories that the current execution would write. It is especially useful in these situations:
1313

14-
- 第一次接入某个项目
15-
- 刚修改过 `plugin.config.ts`
16-
- 刚改过 [输出范围](/docs/cli/output-scopes)
17-
- 准备验证某次批量源内容变更的影响
14+
- When integrating a project for the first time
15+
- Right after changing `plugin.config.ts`
16+
- Right after changing [Output Scopes](/docs/cli/output-scopes)
17+
- Before validating the impact of a large source-content change
1818

19-
## `clean` 的职责
19+
## What `clean` Does
2020

21-
`tnmsc clean` 用来清除已生成的输出文件。它不是“无差别删目录”,而是依据当前输出模型和清理保护规则执行。
21+
`tnmsc clean` removes generated output files. It is not a blind directory deletion command. It follows the current output model and cleanup-protection rules.
2222

23-
在完成常规 cleanup 之后,`tnmsc clean` 还会继续扫描当前 project 的源码树,把剩余的空目录一并清掉。这个 empty-dir sweep 会明确跳过 Git 内部目录,以及依赖、构建产物、缓存一类目录树。
23+
After normal cleanup finishes, `tnmsc clean` also scans the current project source tree and removes remaining empty directories. That empty-dir sweep explicitly skips Git internals as well as dependency, build-output, and cache directory trees.
2424

25-
在真正执行前,优先用:
25+
Before running it for real, prefer:
2626

2727
```sh
2828
tnmsc clean --dry-run
2929
```
3030

31-
`--dry-run` 也会把这些后续会被清掉的空目录一起展示出来。
31+
`--dry-run` will also show the empty directories that would be removed afterward.
3232

33-
## 风险边界
33+
## Risk Boundary
3434

35-
如果输出目录里混有人工文件或其他工具产物,必须先看 [清理保护](/docs/cli/cleanup-protection)。没有保护规则时,`clean` 的风险会显著上升。
35+
If your output directories also contain hand-written files or outputs from other tools, read [Cleanup Protection](/docs/cli/cleanup-protection) first. Without protection rules, the risk of `clean` rises sharply.
3636

37-
## 推荐习惯
37+
## Recommended Habits
3838

39-
1. 改配置或换项目时先 `dry-run`
40-
2. 真要清理时先 `clean --dry-run`
41-
3. 出现异常时再结合 [排障](/docs/cli/troubleshooting) 定位
39+
1. Run `dry-run` first when you change config or switch projects.
40+
2. Run `clean --dry-run` first when you really intend to clean.
41+
3. If something looks wrong, continue with [Troubleshooting](/docs/cli/troubleshooting).

doc/content/cli/first-sync.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
2-
title: 第一次同步
3-
description: 按最短路径完成 tnmsc helpdry-run、真实同步与结果核对。
4-
sidebarTitle: 第一次同步
2+
title: First Sync
3+
description: Walk through tnmsc help, dry-run, the real sync run, and result verification in the shortest path.
4+
sidebarTitle: First Sync
55
status: stable
66
---
77

8-
# 第一次同步
8+
# First Sync
99

10-
## 推荐顺序
10+
## Recommended Order
1111

12-
1. 先运行 `tnmsc help`,确认你面对的是当前命令集。
13-
2. 再运行 `tnmsc dry-run`,确认会写出哪些文件。
14-
3. 确认范围无误后,再执行默认同步管线。
12+
1. Run `tnmsc help` first to confirm that you are looking at the current command set.
13+
2. Run `tnmsc dry-run` next to see which files would be written.
14+
3. Only after confirming the scope should you run the default sync pipeline.
1515

16-
## 最短流程
16+
## Shortest Flow
1717

1818
```sh
1919
tnmsc help
2020
tnmsc dry-run
2121
tnmsc
2222
```
2323

24-
## 为什么不能直接跳过 `dry-run`
24+
## Why You Should Not Skip `dry-run`
2525

26-
因为当前系统不仅会写文件,还会根据配置处理清理边界。第一次接入某个项目时,先看预览比事后回收误写和误删要便宜得多。
26+
The current system does more than write files. It also applies cleanup boundaries based on configuration. On a first integration, checking the preview is much cheaper than recovering from accidental writes or accidental deletions afterward.
2727

28-
如果你不确定清理风险,先补读 [dry-run clean](/docs/cli/dry-run-and-clean) [清理保护](/docs/cli/cleanup-protection)
28+
If you are unsure about cleanup risk, read [dry-run and clean](/docs/cli/dry-run-and-clean) and [Cleanup Protection](/docs/cli/cleanup-protection) first.
2929

30-
## 同步后应该核对什么
30+
## What to Verify After Sync
3131

32-
- 目标工具是不是出现在 [支持的输出目标](/docs/cli/supported-outputs) 范围内
33-
- 真实写入范围是否符合 [输出范围](/docs/cli/output-scopes)
34-
- 某些字段行为是否与 [JSON Schema](/docs/cli/schema) 一致
32+
- Whether the target tool appears in [Supported Outputs](/docs/cli/supported-outputs)
33+
- Whether the actual write scope matches [Output Scopes](/docs/cli/output-scopes)
34+
- Whether field behavior matches the [JSON Schema](/docs/cli/schema)

0 commit comments

Comments
 (0)