重要前提
安装AI Skills的关键前提是:必须科学上网,且开启TUN模式,这一点至关重要,直接决定安装能否顺利完成,在此郑重提醒三遍:科学上网,科学上网,科学上网。查看完整安装教程 →
npx skills add https://github.com/dagster-io/erk --skill learned-docs概述:docs/learned/ 包含面向智能体的文档,具有:
@learned-docs-core.md
@docs/learned/index.md
每个 Markdown 文件(index.md 除外)必须包含:
---
title: 文档标题
read_when:
- "第一个条件"
- "第二个条件"
---
| 字段 | 类型 | 用途 |
|---|---|---|
title | string | 索引表中的人类可读标题 |
read_when |
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
| list[string] |
| 智能体应阅读此文档的条件 |
良好示例:
read_when:
- "creating or closing plans"
- "understanding plan states"
- "working with .erk/impl-context/ directories"
不良示例:
read_when:
- "plans" # 太模糊
- "the user asks" # 描述性不足
阅读主索引以获取当前类别和文档:
docs/learned/index.md
索引包含:
这是最常见的混淆点:
---
title: [清晰的文档标题]
read_when:
- "[第一个条件]"
- "[第二个条件]"
---
# [与前言匹配的标题]
[1-2 句概述]
## [主要内容部分]
[组织清晰、标题明确的内容]
## 相关主题
- [链接到相关文档](../category/doc.md) - 简要描述
每个类别都有一个遵循此模式的 index.md:
---
title: [类别] 文档
read_when:
- "[何时浏览此类别]"
---
# [类别] 文档
[简短的类别描述]
## 快速导航
| 当您需要... | 阅读此文档 |
| ------------------- | ---------------- |
| [具体任务] | [doc.md](doc.md) |
## 此类别中的文档
### [文档标题]
**文件:** [doc.md](doc.md)
[1-2 句描述]
## 相关主题
- [其他类别](../other/) - 简要说明相关性
在类别之间移动文件时:
cd docs/learned
git mv old-location/doc.md new-category/doc.md
查找对已移动文件的所有引用:
grep -r "old-filename.md" docs/learned/
更新相对链接:
[doc.md](doc.md)[doc.md](../category/doc.md)[Category](../category/)更新受影响索引文件中的快速导航表。
如果文档在路由表中,请更新路径。
运行 make fast-ci 以捕获损坏的链接和格式问题。
AGENTS.md 包含用于智能体导航的快速路由表。
| [任务描述] | → [链接或技能] |
示例:
| 理解项目架构 | → [Architecture](docs/learned/architecture/) || 编写 Python 代码 | → 首先加载 \dignified-python 技能 |提交前运行:
make fast-ci
这将验证:
以下文件是自动生成的,源自前言元数据:
| 文件 | 来源 |
|---|---|
docs/learned/index.md | 所有文档的前言 |
docs/learned/<category>/index.md | 类别中文档的前言 |
docs/learned/<category>/tripwires.md | 类别文档中的 tripwires: 字段 |
docs/learned/tripwires-index.md | 带有路由提示的类别触发警告 |
切勿直接编辑这些文件。 更改将被覆盖。
erk docs sync要添加触发警告规则:
tripwires: 字段:
tripwires:
- action: "doing something dangerous"
warning: "Do this instead."
erk docs sync 以重新生成 tripwires.mderk docs syncmake fast-ci每周安装次数
54
代码仓库
GitHub Stars
74
首次出现
Jan 20, 2026
安全审计
安装于
opencode53
github-copilot53
codex53
claude-code52
kimi-cli52
gemini-cli52
Overview: docs/learned/ contains agent-focused documentation with:
@learned-docs-core.md
@docs/learned/index.md
Every markdown file (except index.md) MUST have:
---
title: Document Title
read_when:
- "first condition"
- "second condition"
---
| Field | Type | Purpose |
|---|---|---|
title | string | Human-readable title for index tables |
read_when | list[string] | Conditions when agent should read this doc |
Good:
read_when:
- "creating or closing plans"
- "understanding plan states"
- "working with .erk/impl-context/ directories"
Bad:
read_when:
- "plans" # Too vague
- "the user asks" # Not descriptive
Read the master index for current categories and documents:
docs/learned/index.md
The index contains:
This is the most common confusion:
cli/ : Patterns for building CLI commands - how users interact with the tool
architecture/ : Internal implementation patterns - how the code works
---
title: [Clear Document Title]
read_when:
- "[first condition]"
- "[second condition]"
---
# [Title Matching Frontmatter]
[1-2 sentence overview]
## [Main Content Sections]
[Organized content with clear headers]
## Related Topics
- [Link to related docs](../category/doc.md) - Brief description
Each category has an index.md following this pattern:
---
title: [Category] Documentation
read_when:
- "[when to browse this category]"
---
# [Category] Documentation
[Brief category description]
## Quick Navigation
| When you need to... | Read this |
| ------------------- | ---------------- |
| [specific task] | [doc.md](doc.md) |
## Documents in This Category
### [Document Title]
**File:** [doc.md](doc.md)
[1-2 sentence description]
## Related Topics
- [Other Category](../other/) - Brief relevance
When moving files between categories:
cd docs/learned
git mv old-location/doc.md new-category/doc.md
Find all references to moved files:
grep -r "old-filename.md" docs/learned/
Update relative links:
[doc.md](doc.md)[doc.md](../category/doc.md)[Category](../category/)Update Quick Navigation tables in affected index files.
If the doc was in the routing table, update the path.
Run make fast-ci to catch broken links and formatting issues.
AGENTS.md contains the Quick Routing Table for agent navigation.
| [Task description] | → [Link or skill] |
Examples:
| Understand project architecture | → [Architecture](docs/learned/architecture/) || Write Python code | → Load \dignified-python skill FIRST |Run before committing:
make fast-ci
This validates:
The following files are auto-generated from frontmatter metadata:
| File | Source |
|---|---|
docs/learned/index.md | Frontmatter from all docs |
docs/learned/<category>/index.md | Frontmatter from category |
docs/learned/<category>/tripwires.md | tripwires: field in category docs |
docs/learned/tripwires-index.md | Category tripwires with routing hints |
Never edit these files directly. Changes will be overwritten.
erk docs syncTo add a tripwire rule:
Add to the tripwires: field in the relevant doc's frontmatter:
tripwires:
- action: "doing something dangerous"
warning: "Do this instead."
Run erk docs sync to regenerate tripwires.md
erk docs syncmake fast-ciWeekly Installs
54
Repository
GitHub Stars
74
First Seen
Jan 20, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
opencode53
github-copilot53
codex53
claude-code52
kimi-cli52
gemini-cli52
超能力技能使用指南:AI助手技能调用优先级与工作流程详解
53,700 周安装
通用项目发布工具 - 多语言更新日志自动生成 | 支持Node.js/Python/Rust/Claude插件
62 周安装
Edge Pipeline Orchestrator:自动化金融交易策略流水线编排工具
62 周安装
Python ROI 计算器:投资回报率、营销ROI、盈亏平衡分析工具
62 周安装
Salesforce Hyperforce 2025架构指南:云原生、零信任安全与开发最佳实践
62 周安装
PowerShell 2025 重大变更与迁移指南:版本移除、模块停用、WMIC替代方案
62 周安装
2025安全优先Bash脚本编写指南:输入验证、命令注入与路径遍历防护
62 周安装