---
title: "文件 · yokoten · 横展"
description: "yokoten 使用指南的目錄：每一節、每個指令各一行，點進去就是 GitHub 上的那一節。"
canonical: https://yokoten.app/zh-tw/docs
last-updated: 2026-10-22
lang: zh-TW
---

> 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 上加上標準標籤和第一個里程碑。
- [`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-tw/index.md)
- [運作方式 · yokoten · 横展](https://yokoten.app/zh-tw/how-it-works.md)
- [路線圖 · yokoten · 横展](https://yokoten.app/zh-tw/roadmap.md)
- [快速開始 · yokoten · 横展](https://yokoten.app/zh-tw/start.md)
- [關於 · yokoten · 横展](https://yokoten.app/zh-tw/about.md)
- [聯絡 · yokoten · 横展](https://yokoten.app/zh-tw/contact.md)
- [隱私 · yokoten · 横展](https://yokoten.app/zh-tw/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/docs.md) · [日本語](https://yokoten.app/ja/docs.md)

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

© 2026 yokoten-labs