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

# 快速开始

Step Code 一条脚本命令安装、一次登录就能开始工作。从安装、登录到第一个对话和项目指引，本页带您完成基本工作流。

## Step Code 是什么

Step Code 是一个运行在终端中的 AI Agent，帮助您完成软件开发任务和日常终端操作：阅读和修改代码、执行 Shell 命令、搜索文件、抓取网页，并根据执行反馈自主规划和调整下一步。Step Code 由阶跃星辰打造，为阶跃模型深度调优。

* 编写代码：实现功能、修复问题、补充测试和重构。
* 理解项目：梳理目录、依赖、入口和本地运行方式。
* 自动化任务：执行一次性脚本、批量修改和定时任务。
* 管理长任务：通过 `/goal` 托管几小时量级的任务，回来后查看进度与结果。
* 多代理并行：用 workflow 编排多个子代理分头处理任务。
* 发布静态网站：通过 `steppage` 插件部署构建产物。

## 安装

建议使用 Kitty、Ghostty、iTerm2 或 Windows Terminal 等现代终端。图片显示、真彩色和部分组合键的支持取决于终端配置。

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
    curl -fsSL https://static-openapi.stepfun.com/stepcode/install.sh | bash
    ```
  </Tab>

  <Tab title="Windows">
    在 PowerShell 中执行：

    ```powershell theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
    irm https://static-openapi.stepfun.com/stepcode/install.ps1 | iex
    ```

    Windows PowerShell 支持处于 beta 阶段；Windows 上推荐在 WSL 中使用 Linux 安装命令。
  </Tab>
</Tabs>

安装器拉取 `latest.json` 版本清单，按平台下载安装包，校验 checksum，解压到 `~/.stepcode/bin`（含运行时资源），配置 PATH，最后进行冒烟测试。`rg` / `fd` 托管工具按需下载到 `~/.stepcode/agent/bin`。

zsh、bash 和 POSIX 登录配置会追加带标记的 PATH 块；fish 使用 `fish_add_path`；Windows 写入注册表并广播生效，默认安装目录为 `%USERPROFILE%\.stepcode\bin`。

<Note>
  安装命令会执行远程脚本。运行前请确认来源可信；如需审查，可先下载脚本再执行。安装完成后重新打开终端。
</Note>

```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
step --version
```

安装器支持 `--version <vX.Y.Z|latest>` 和 `--install-dir <路径>`。也可通过 `STEP_RELEASE_BASE_URL`、`STEP_INSTALL_DIR`、`STEP_CODING_AGENT_DIR` 覆盖发行源和目录。开源仓库：[Step-Code](https://github.com/stepfun-ai/Step-Code)。

## 首次启动

进入您希望处理的项目目录：

```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
cd /path/to/project
step
```

首次启动依次进入登录、MCP 导入、主题选择器和主界面。检测到 Claude Code 或 Codex 的 MCP 配置时显示导入屏；主题选择器高亮即预览，原工具配置不会被修改。

其他启动方式：

```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
step -p "这个项目怎么跑起来？"
step -c
```

`-p` 执行一次任务后退出，`-c` 继续最近一次会话。

## 登录

在交互界面输入 `/login`，选择适合账户的登录方式：

| 方式             | 操作                                                  |
| -------------- | --------------------------------------------------- |
| Step Plan 国内订阅 | 选择 Step Plan，在 `platform.stepfun.com` 完成账号登录        |
| Step Plan 海外订阅 | 选择 Step Plan Oversea，在 `platform.stepfun.ai` 完成账号登录 |
| API Key        | 选择对应平台并填写密钥，或在启动前设置该供应商要求的环境变量                      |

OAuth 凭据自动刷新；API Key 可在启动前设置，例如 `export ANTHROPIC_API_KEY="YOUR_ANTHROPIC_API_KEY"`，也可通过 `/login` 保存到 `~/.stepcode/auth.json`。使用 `/logout` 清除对应登录凭据。全部平台见[平台与模型](/docs/zh/step-code/configuration/models)。

订阅与按量付费是不同的通道。请按账户所在地区和计费方式选择平台，不能仅凭模型名称判断使用了哪种额度。

## 第一个对话

输入任务并按 Enter：

```text theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
这个项目用什么技术栈？各目录分别负责什么？本地怎么把它跑起来？
```

模型通过 `read` 读文件、`write` 写文件、`edit` 修改文件、`bash` 执行 Shell 命令；`grep` / `find` / `ls` 等只读搜索工具可在设置中开启。配置名称和模型侧名称见[内置工具](/docs/zh/step-code/reference/tools)。

<Warning>
  默认权限模式为 Bypass，普通文件修改和 Shell 命令不会逐项请求确认。需要审批时先运行 `/permissions` 并选择 Ask。权限模式不是系统沙箱，只在可信目录中运行；不受信任的项目或无人值守任务应使用独立容器或虚拟机。
</Warning>

确认工作范围后，再提出修改任务，例如：

```text theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
为 src/api/errors.ts 里的错误码整理一份对照表，包含错误码、含义和触发场景，保存到 docs/errors.md。
```

## 给项目加指引

在项目根目录创建 `AGENTS.md`，写明约定和检查要求：

```markdown theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
# 项目指引

- 代码改动后运行 npm run check
- 不要在本地跑生产迁移
- 回复保持简洁
```

Step Code 加载全局 `~/.stepcode/agent/AGENTS.md`，以及当前目录和父目录的项目指引。每个目录按 `AGENTS.override.md`、`AGENTS.md`、`CLAUDE.md` 的顺序选择第一个文件。修改后运行 `/reload` 或重新启动。

也可以运行 `/init`，让模型检查项目后生成指引；保存前请审查内容。

## 常用命令与快捷键

| 命令或快捷键                | 作用                 |
| --------------------- | ------------------ |
| `/model`              | 选择模型               |
| `/permissions`        | 切换工具审批模式           |
| `/thinking`、`/effort` | 设置思考级别             |
| `/plan`               | 切换 Plan 模式；可附带任务描述 |
| Esc                   | 中断输出或关闭弹窗          |
| Ctrl+C                | 清空输入；空输入时再次按下退出    |
| Shift+Tab             | 循环切换权限模式           |
| Ctrl+L                | 重绘屏幕               |
| Ctrl+O                | 折叠或展开工具输出          |
| Enter（流式输出期间）         | 排队消息，当前轮工具执行完后送达   |

完整列表见[斜杠命令](/docs/zh/step-code/reference/slash-commands)和[键盘快捷键](/docs/zh/step-code/reference/keyboard-shortcuts)。

## 数据存放在哪里

默认配置、凭据和会话记录保存在本机 `~/.stepcode/` 下；项目资源保存在项目的 `.stepcode/` 目录。详见[数据路径](/docs/zh/step-code/configuration/data-paths)。

本地保存不等于数据不会发送到外部：调用模型会发送提示词、相关代码或工具结果；MCP、插件、反馈和部署也可能访问外部服务。不要向无权限接收这些数据的服务发送敏感信息。

## 升级与卸载

```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
step update
```

`step update` 自动检查并安装最新稳定版，包含 checksum 校验、冒烟测试和失败回滚。`step update 0.4.0` 展示指定版本的用法（将版本号替换为所需发行版本）；`step upgrade` 是别名。包更新方式见 [`step` 命令](/docs/zh/step-code/reference/cli)。

脚本安装的版本可通过删除安装目录中的 `step` 可执行文件卸载；Windows 删除 `step.exe`。同时清理安装器写入的 PATH 配置。配置、凭据和会话不会因此删除，如需彻底清理，请先备份，再按[数据清理说明](/docs/zh/step-code/configuration/data-paths#清理数据)处理。不要删除被其他工具共用的目录。

## 下一步

* [交互与输入](/docs/zh/step-code/guides/interaction)：文件引用、审批、Plan 和目标模式。
* [会话与上下文](/docs/zh/step-code/guides/sessions)：恢复、压缩和导出会话。
* [常见使用案例](/docs/zh/step-code/guides/use-cases)：可以直接使用的任务示例。