> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 使用 Olostep CLI 与 AI 代理

> Claude Code、Cursor、Codex 和其他编码代理如何运行 olostep 命令。

AI 编码代理可以像其他命令一样运行 `olostep`。CLI 会注意到当一个编码代理运行它时，会为程序而非人为操作。

## 设置

**1. 安装 CLI 并自行登录**

```bash theme={null}
curl -fsSL https://cli.olostep.com | sh
olostep login
```

代理使用你在这台计算机上的登录。在 CI 中，设置 `OLOSTEP_TOKEN`。请参阅[身份验证](https://docs.olostep.com/cli/authentication.md#scripts-ci-and-agents)。

**2. 给代理提供 CLI 指南**

```bash theme={null}
olostep skill get olostep-cli --write .claude/skills
```

这会写入 `.claude/skills/olostep-cli/SKILL.md`：如何运行 CLI、其退出代码以及每个命令的标志和 JSON 输出模式。使用你的代理的技能文件夹代替 `.claude/skills`。

**3. 告诉代理使用 --json**

代理应该使用 `--json` 运行命令并读取 JSON。人类输出是给人看的，可能会改变。

## CLI 如何为代理运行

当没有终端，或者设置了 `CLAUDECODE`、`CURSOR_AGENT`、`CODEX_CI` 或 `AI_AGENT` 之一时，CLI 将运行视为代理的操作。然后：

* 没有命令的 `olostep` 打印帮助，而不是欢迎屏幕。
* 它从不提示。需要登录的命令以代码 `3` 退出，并在 stderr 上告诉代理运行 `olostep login` 或设置 `OLOSTEP_TOKEN`。
* 可能删除或覆盖某些内容的命令以代码 `4` 退出，除非你传递 `--yes`。
* `olostep keys reveal` 从不打印密钥。使用 `--write-env <file>` 将其保存到 git 忽略的环境文件中。
* `olostep chat` 以纯文本打印回复（`--plain` 已开启），并需要一条消息。
* 不会打印更新通知。

| 退出代码 | 代理应该做什么 |
| - | - |
| `0` | 阅读输出。 |
| `1` | 阅读 stderr 上的错误。 |
| `2` | 使用 `olostep <command> --help` 检查命令。 |
| `3` | 让人运行 `olostep login`。 |
| `4` | 与人确认，然后使用 `--yes` 再次运行。 |
| `5` | 服务器无法访问。稍后重试。 |

## 找到正确的命令

```bash theme={null}
olostep help monitor pause        # 名称或描述中包含每个单词的命令
olostep tools --search crawl      # 提到“crawl”的工具
olostep tools crawl_create        # 一个工具的完整输入和输出模式
```

## `olostep skill`

技能是针对一种任务的简短指令。列出它们、阅读它们，或将它们写入代理的技能文件夹：

```bash theme={null}
olostep skill list
olostep skill get credit-usage
olostep skill get olostep-cli dashboard --write .claude/skills
olostep skill get olostep-cli --json
```

| 技能 | 覆盖内容 |
| - | - |
| `olostep-cli` | 如何使用 `olostep` 命令行。从 CLI 的命令生成。 |
| `credit-usage` | 信用余额、计划、信用到期和每日使用情况。 |
| `dashboard` | 仪表板功能：账户、账单、团队、API 密钥、日志、作业、解析器、监控器、代理、支持和集成。 |

`olostep skill list` 显示当前列表。查看 [`olostep skill`](https://docs.olostep.com/cli/reference/cli-commands#olostep-skill) 了解标志。

## `olostep tools`

每个 CLI 命令都会在 Olostep 服务器上调用一个工具。`olostep tools` 列出它们，并标记那些会改变内容的工具：

```bash theme={null}
olostep tools
olostep tools --json
```

## 提供反馈

当命令失败、缺失或令人困惑时，代理可以告诉 Olostep 团队。这无需登录：

```bash theme={null}
olostep feedback --about tooling --message "crawl create rejected --depth 0"
```

对于 CLI 本身使用 `--about tooling`，对于 Olostep 使用 `--about product`。切勿包含密钥、密码或个人详细信息。

## 使用 MCP 而不是终端

如果你的代理支持 MCP，你可以直接将其连接到 Olostep。请参阅 [MCP 服务器](https://docs.olostep.com/integrations/mcp-server.md)，或为你的客户端打印设置：

```bash theme={null}
olostep integrations config --client claude_code
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.