fallow-codex-onboarding

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Set up Fallow in Codex

在Codex中设置Fallow

Use the Fallow app tools. Keep each step short. Ask one question at a time.

使用Fallow应用工具。每一步保持简短，一次只提一个问题。

1. Check the installation

1. 检查安装情况

Call

fallow_check_install

with

{}

If it reports a version, continue.
If fallow is missing, explain that the app runs the fallow CLI locally and that no code leaves the machine. Offer to install it globally with
```
npm install --global fallow
```
. The sidebar dashboard needs a fallow on PATH, because the app runs a copy inside the project only within the Codex sandbox of a thread. Run the install only after the user agrees. Then call
```
fallow_check_install
```
again.

调用参数为

{}

的

fallow_check_install

。

如果返回了版本号，继续下一步。
如果未找到fallow，请向用户说明：该应用在本地运行fallow CLI，不会有代码流出设备。可提议通过
```
npm install --global fallow
```
全局安装。侧边栏仪表盘需要PATH中存在fallow，因为应用仅在线程的Codex沙箱内的项目中运行副本。仅在用户同意后再执行安装，随后重新调用
```
fallow_check_install
```
。

2. Choose the defaults

2. 选择默认配置

Call

fallow_settings_read

with

{}

. Ask these questions, one at a time. Skip a question when the user already answered it.

"Analyze the whole project by default, or only the files your branch changed?" Map the whole project to
```
scope: "full"
```
and changed files to
```
scope: "changed"
```
.
"Leave tests, stories and dev tooling out of the analysis?" Map yes to
```
production: true
```
.

Call

fallow_settings_update

with a

set

object that holds only the changed values, for example

{"set":{"scope":"changed"}}

. Skip the call when nothing changed. Report the saved values from the tool result. Do not say that a value was saved when the call failed.

调用参数为

{}

的

fallow_settings_read

。一次提一个以下问题，若用户已回答过则跳过对应问题。

“默认分析整个项目，还是仅分析您的分支修改的文件？” 整个项目对应
```
scope: "full"
```
，修改的文件对应
```
scope: "changed"
```
。
“是否将测试、stories和开发工具排除在分析范围之外？” 选择“是”对应
```
production: true
```
。

调用

fallow_settings_update

，传入仅包含变更值的

set

对象，例如

{"set":{"scope":"changed"}}

。若无变更则跳过调用。根据工具返回结果告知用户已保存的值，调用失败时不要声称值已保存。

3. Run the first analysis

3. 运行首次分析

Call

fallow_analyze

with

{}

. The user sees the dashboard. In two or three sentences, give the health score, the largest category of findings, and one finding to start with.

If the result says that no project is known, ask the user to open a project folder in this thread, then call

fallow_analyze

again.

调用参数为

{}

的

fallow_analyze

。用户将看到仪表盘。用两三句话说明健康评分、占比最高的问题类别，以及一个可优先处理的问题。

如果结果提示未识别到项目，请让用户在该线程中打开一个项目文件夹，随后重新调用

fallow_analyze

。

4. Show what the app adds

4. 介绍应用新增功能

Tell the user, in a short list:

Fallow in the sidebar opens the full dashboard.
Code Health opens beside a thread and follows the project of that thread.
Type @Fallow in the composer to attach a finding or all findings of a rule.
Open
```
.fallowrc.json
```
or
```
.fallowrc.jsonc
```
to edit rules and preview their impact before saving.
```
.sarif
```
files open in a findings viewer.
Before a commit, ask Codex to audit the branch.

用简短的列表向用户说明：

侧边栏中的 Fallow 可打开完整仪表盘。
Code Health 会在线程旁打开，并跟随该线程对应的项目。
在输入框中输入 @Fallow 可附加单个问题或某条规则的所有问题。
打开
```
.fallowrc.json
```
或
```
.fallowrc.jsonc
```
可编辑规则，并在保存前预览影响。
```
.sarif
```
文件可在问题查看器中打开。
提交代码前，可让Codex审计分支。

5. Offer the next step

5. 提供下一步建议

If the project has no fallow config file (

.fallowrc.json

.fallowrc.jsonc

fallow.toml

.fallow.toml

), offer the

fallow-setup

skill to add one and a CI gate. If the user installed the plugin during another task, continue that task in this conversation.

如果项目没有fallow配置文件（

.fallowrc.json

、

.fallowrc.jsonc

、

fallow.toml

或

.fallow.toml

），可提议使用

fallow-setup

技能添加配置文件和CI门禁。如果用户是在其他任务过程中安装的插件，请在本次对话中继续完成该任务。