---
title: "文档 · yokoten · 横展"
description: "yokoten 使用指南的目录：每一节、每个命令各一行，点进去就是 GitHub 上的那一节。"
canonical: https://yokoten.app/zh/docs
last-updated: 2026-10-22
lang: zh-CN
---

> For AI agents: the documentation index is at https://yokoten.app/llms.txt. To set up yokoten in a project, follow https://yokoten.app/agents.md.

# 文档 · yokoten · 横展

> yokoten 使用指南的目录：每一节、每个命令各一行，点进去就是 GitHub 上的那一节。

文档就是 GitHub 上的[使用指南](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md)，一整页，很长。这里把里面有什么列出来，一行一项，点一下就跳到那一节。

## 使用指南，一节一节看

- [一条赛道](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#一条赛道): 一张图看懂 yokoten：agent 是一辆快车，yokoten 是它跑的赛道。
- [先认识几个词](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#先认识几个词): 会话、hook、CI、pull request 这些词，用大白话讲一遍。
- [名字的来历](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#名字的来历): 「横展」从哪来：一条产线的改进，推广到每条产线。
- [要解决的问题](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#要解决的问题): 用 AI agent 做项目时吃过的亏，为什么只留在那一个项目里。
- [装上的第一天，有什么不同](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#装上的第一天有什么不同): agent 想做什么，没有 yokoten 会怎样，有了又会怎样。
- [三道检查，一把锁](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#三道检查一把锁): 工具调用 hook、提交检查、CI，再加上服务器上的锁：各在什么时候跑，拦下什么。
- [会话里看到的是什么](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#会话里看到的是什么): 每次会话开头的那段提示，还有只存在这台电脑上、还没保存出去的活。
- [四层](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#四层): 电脑、项目、服务器、规则四层；老项目怎么一条一条决定要不要用。
- [支持哪些 agent](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#支持哪些-agent): 守卫能在哪些 AI 编程 agent 里跑，每个都真的试过。
- [安装和命令](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#安装和命令): 要准备什么（Node 22.18 或更高版本），有哪几种装法。
  - [用 Claude Code 插件装](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#用-claude-code-插件装): 在 Claude Code 的会话里直接装。
  - [用 npx 装](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#用-npx-装): 四行命令，用哪个 agent 都行，不用 agent 也行。
  - [从 clone 下来的仓库装](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#从-clone-下来的仓库装): 同样的步骤，用仓库的副本来装。
  - [当成 GitHub Action 用](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#当成-github-action-用): 加一个 workflow 文件，就在 CI 里跑检查，什么都不用装。
  - [不开 CI 的私有仓库（英文）](https://github.com/yokoten-labs/yokoten/blob/main/docs/guide.md#a-private-repo-without-ci): 私有仓库的 GitHub Actions 要按分钟付费，这时可以先把 CI 关掉。
  - [命令](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): init 会写哪些文件，所有命令的总表，JSON 输出，CI 里怎么显示问题。
  - [退出码](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#退出码): 每个退出码是什么意思。
  - [出了问题怎么办](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#出了问题怎么办): agent 打不开、检查没通过的时候，该怎么办。
  - [收尾检查](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#收尾检查): agent 每轮结束时的检查，专门查脚本改过的文件。
  - [禁用的命令](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#禁用的命令): 让「不用 Python」这种技术栈规定，由守卫来执行。
  - [yokoten.json](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#yokotenjson): 项目的设置文件，每一项都可以不写。
  - [issue 标题](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#issue-标题): issue 标题怎么写：先写哪一块，再写要做的事。
  - [更新日志](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#更新日志): 每个 pull request 加一个小文件，发版时汇总进 CHANGELOG.md。
  - [翻译](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#翻译): 译文会写明它对应的原文，原文改了、译文没跟上，就能看出来。
  - [更新规则](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#更新规则): 把你项目 AGENTS.md 里的核心规则更新到最新。
  - [从事故里学](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#从事故里学): 把一次出错变成一条检查，所有项目都会跑。
- [核心规则](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#核心规则): 每个项目都有的 12 条规则，每条都有对应的检查。
- [起名字](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#起名字): 代码里起名字的 5 条规矩，以及为什么。
- [像带团队一样管 agent](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#像带团队一样管-agent): 负责人、机器人、干活的 agent、审查的 agent，各有各的分工，权限都有限。
  - [谁来审什么](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#谁来审什么): 按风险来审：pull request 上的等级，说明改错了有多难撤回。
- [隐私](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#隐私): 查个人信息和密钥的检查，还有存在仓库外面的私人标记。
  - [agent 读到的东西](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#agent-读到的东西): 命令的输出会发给模型，怎么不让你的信息出现在里面。
- [做不到的事](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#做不到的事): 它做不到什么，老实说清楚。
- [故意没带过来的](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#故意没带过来的): 有些做法花的力气比省下的多，所以没放进来。
- [现状](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#现状): 现在是哪个版本，决定记录在哪，接下来往哪走。

## 命令

用法是 `npx yokoten <命令>`。每个命令加上 `--help`，都会打印自己的说明。

- [`install`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 把技能、agent 和两个用户级的 hook 装到这台电脑上。每台电脑装一次。
- [`init [dir]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 把这套做法装进项目：规则、提交检查、工具调用 hook、CI 和模板。已经有的文件会保留。
- [`init --github --yes`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 在 GitHub 上加上标准标签和第一个 milestone。
- [`init --no-ci`](https://github.com/yokoten-labs/yokoten/blob/main/docs/guide.md#a-private-repo-without-ci): 不开 CI。适合 Actions 要按分钟付费的私有仓库。
- [`update [--write]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#更新规则): 看看 AGENTS.md 里的核心规则会有哪些变化；加 --write 就直接替换。
- [`doctor [--session] [--json]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 看看项目走到了第几关，下一步做什么。
- [`adopt [--json]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#四层): 给老项目起草一份采用表。什么都不写入。
- [`check [--staged] [--json]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 检查目录结构、隐私和只有负责人能改的文件，查整个仓库或下一次提交。
- [`check --pr`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#更新日志): 在 CI 里检查 pull request 的标题、各部分内容、关联的 issue、改动说明文件和标签。
- [`check --issue`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#issue-标题): 在 CI 里检查 issue 的标题。
- [`check --history`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#隐私): 把过去每一次提交都做一遍隐私检查。私有仓库公开之前先跑一次。
- [`redact`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#隐私): 读进一段文字，把你的个人信息遮掉再输出。
- [`marks allow <mark> --here`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#隐私): 让某一个私人标记只在这个仓库里放行。
- [`changelog [--write]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#更新日志): 看看改动说明文件会往更新日志里加什么；加 --write 就写进去。
- [`learn <issue> [--write]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#从事故里学): 根据一个事故 issue 起草一条检查，交给人来审。
- [`learn --upstream "<what happened>"`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 记下 yokoten 自己的问题，项目和你的信息都会遮掉。
- [`hook [--agent <name>]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 工具调用守卫，agent 每次动手前都会先跑它。
- [`hook --stop`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#收尾检查): 收尾检查，agent 每轮结束时跑。
- [`explain [<id>]`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 讲清楚一条规则或一个步骤：是什么，为什么，yokoten 怎么检查。
- [`uninstall`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 撤掉 install 装的东西。你自己的文件和设置都会留着。
- [`bot -- <command>`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 用机器人的身份跑一条 gh 或 git push 命令，令牌一小时就过期。
- [`help <command>, version`](https://github.com/yokoten-labs/yokoten/blob/main/docs/i18n/zh-CN/guide.md#命令): 查看某个命令的说明，以及版本号。

---

- [yokoten · 横展：给 AI 编程 agent 的护栏，带你养成好团队的习惯](https://yokoten.app/zh/index.md)
- [原理 · yokoten · 横展](https://yokoten.app/zh/how-it-works.md)
- [开发蓝图 · yokoten · 横展](https://yokoten.app/zh/roadmap.md)
- [快速开始 · yokoten · 横展](https://yokoten.app/zh/start.md)
- [关于 · yokoten · 横展](https://yokoten.app/zh/about.md)
- [联系 · yokoten · 横展](https://yokoten.app/zh/contact.md)
- [隐私 · yokoten · 横展](https://yokoten.app/zh/privacy.md)
- [agents.md](https://yokoten.app/agents.md)
- [llms.txt](https://yokoten.app/llms.txt)

语言: [English](https://yokoten.app/docs.md) · [繁體中文](https://yokoten.app/zh-tw/docs.md) · [日本語](https://yokoten.app/ja/docs.md)

HTML: https://yokoten.app/zh/docs

© 2026 yokoten-labs