Skip to content

Commit ab7a815

Browse files
winlinvipclaude
andcommitted
Update AI agents doc: add Kiro, fix Codex and OpenClaw config paths
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent b34a791 commit ab7a815

2 files changed

Lines changed: 42 additions & 14 deletions

File tree

i18n/en-us/docusaurus-plugin-content-docs/current/doc/getting-started-ai.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hide_table_of_contents: false
77

88
# AI Agent
99

10-
SRS provides several ways to use AI: you can chat with the SRS Robot in Telegram or Discord for quick answers, or run AI locally with Claude Code, Codex, or OpenClaw using the pre-configured SRS knowledge base.
10+
SRS provides several ways to use AI: you can chat with the SRS Robot in Telegram or Discord for quick answers, or run AI locally with OpenClaw, Claude Code, Codex, or Kiro using the pre-configured SRS knowledge base.
1111

1212
## SRS Robot
1313

@@ -37,7 +37,7 @@ Claude Code will automatically load the configuration from `srs/.claude`, giving
3737

3838
## Codex
3939

40-
You can also use Codex locally with the SRS codebase. SRS ships with a pre-configured `.agents` directory so Codex works out of the box.
40+
You can also use Codex locally with the SRS codebase. SRS ships with a pre-configured `.codex` directory so Codex works out of the box.
4141

4242
Clone the SRS code and start Codex:
4343

@@ -47,7 +47,21 @@ cd srs
4747
codex
4848
```
4949

50-
Codex will automatically load the configuration from `srs/.agents`.
50+
Codex will automatically load the configuration from `srs/.codex`.
51+
52+
## Kiro
53+
54+
You can also use Kiro locally with the SRS codebase. SRS ships with a pre-configured `.kiro` directory so Kiro works out of the box.
55+
56+
Clone the SRS code and start Kiro:
57+
58+
```bash
59+
git clone https://github.com/ossrs/srs.git
60+
cd srs
61+
kiro-cli
62+
```
63+
64+
Kiro will automatically load the configuration from `srs/.kiro`.
5165

5266
## OpenClaw
5367

@@ -59,18 +73,18 @@ git clone https://github.com/ossrs/srs.git
5973

6074
There are two ways to point the agent at the SRS knowledge base:
6175

62-
- **Set the workspace directly** — when creating the agent, set the workspace path to `srs/openclaw`.
63-
- **Soft link** — create the agent with its default workspace, then remove the default workspace directory and replace it with a soft link to `srs/openclaw`:
76+
- **Set the workspace directly** — when creating the agent, set the workspace path to `srs/.openclaw`.
77+
- **Soft link** — create the agent with its default workspace, then remove the default workspace directory and replace it with a soft link to `srs/.openclaw`:
6478

6579
```bash
66-
ln -sf ~/git/srs/openclaw ~/.openclaw/workspace
80+
ln -sf ~/git/srs/.openclaw ~/.openclaw/workspace
6781
```
6882

6983
Once the agent is running, list the available skills and trigger them to load the knowledge base. The skills tell the AI which files to load and how to work more effectively with the SRS codebase.
7084

7185
## Skills
7286

73-
After starting Claude Code, Codex, or OpenClaw with the SRS codebase, you should use skills to get the best results. Skills load the right knowledge base for your task and guide the AI through the correct workflow.
87+
After starting OpenClaw, Claude Code, Codex, or Kiro with the SRS codebase, you should use skills to get the best results. Skills load the right knowledge base for your task and guide the AI through the correct workflow.
7488

7589
The `srs-support` skill is provided for answering questions about the SRS project. It automatically loads the relevant knowledge base based on your question, so the AI can give you accurate and context-aware answers.
7690

i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/getting-started-ai.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hide_table_of_contents: false
77

88
# AI Agent
99

10-
SRS 提供了多种使用 AI 的方式:您可以在 Telegram 或 Discord 中与 SRS Robot 对话快速获取解答,也可以通过 Claude Code、Codex 或 OpenClaw 在本地运行 AI,使用预配置的 SRS 知识库进行开发和调试。
10+
SRS 提供了多种使用 AI 的方式:您可以在 Telegram 或 Discord 中与 SRS Robot 对话快速获取解答,也可以通过 OpenClaw、Claude Code、Codex 或 Kiro 在本地运行 AI,使用预配置的 SRS 知识库进行开发和调试。
1111

1212
## SRS Robot
1313

@@ -37,7 +37,7 @@ Claude Code 将自动加载 `srs/.claude` 中的配置,使其深度了解 SRS
3737

3838
## Codex
3939

40-
您也可以在本地使用 Codex 与 SRS 代码库协作。SRS 内置了预配置的 `.agents` 目录,Codex 开箱即用。
40+
您也可以在本地使用 Codex 与 SRS 代码库协作。SRS 内置了预配置的 `.codex` 目录,Codex 开箱即用。
4141

4242
克隆 SRS 代码并启动 Codex:
4343

@@ -47,7 +47,21 @@ cd srs
4747
codex
4848
```
4949

50-
Codex 将自动加载 `srs/.agents` 中的配置。
50+
Codex 将自动加载 `srs/.codex` 中的配置。
51+
52+
## Kiro
53+
54+
您也可以在本地使用 Kiro 与 SRS 代码库协作。SRS 内置了预配置的 `.kiro` 目录,Kiro 开箱即用。
55+
56+
克隆 SRS 代码并启动 Kiro:
57+
58+
```bash
59+
git clone https://github.com/ossrs/srs.git
60+
cd srs
61+
kiro-cli
62+
```
63+
64+
Kiro 将自动加载 `srs/.kiro` 中的配置。
5165

5266
## OpenClaw
5367

@@ -59,18 +73,18 @@ git clone https://github.com/ossrs/srs.git
5973

6074
有两种方式将 Agent 指向 SRS 知识库:
6175

62-
- **直接设置工作空间** — 创建 Agent 时,将工作空间路径设置为 `srs/openclaw`
63-
- **软链接** — 使用默认工作空间创建 Agent,然后删除默认工作空间目录,并将其替换为指向 `srs/openclaw` 的软链接:
76+
- **直接设置工作空间** — 创建 Agent 时,将工作空间路径设置为 `srs/.openclaw`
77+
- **软链接** — 使用默认工作空间创建 Agent,然后删除默认工作空间目录,并将其替换为指向 `srs/.openclaw` 的软链接:
6478

6579
```bash
66-
ln -sf ~/git/srs/openclaw ~/.openclaw/workspace
80+
ln -sf ~/git/srs/.openclaw ~/.openclaw/workspace
6781
```
6882

6983
Agent 启动后,列出可用的 Skill 并触发它们以加载知识库。Skill 会告诉 AI 需要加载哪些文件,以及如何更高效地处理 SRS 代码库相关的工作。
7084

7185
## Skills
7286

73-
在启动 Claude Code、Codex 或 OpenClaw 并接入 SRS 代码库后,建议使用 Skill 以获得最佳效果。Skill 会为当前任务加载正确的知识库,并引导 AI 按照正确的工作流执行。
87+
在启动 OpenClaw、Claude Code、Codex 或 Kiro 并接入 SRS 代码库后,建议使用 Skill 以获得最佳效果。Skill 会为当前任务加载正确的知识库,并引导 AI 按照正确的工作流执行。
7488

7589
`srs-support` Skill 用于解答 SRS 项目相关的问题。它会根据您的问题自动加载相关知识库,让 AI 给出准确且有上下文的回答。
7690

0 commit comments

Comments
 (0)