Step-Code README

The project's README from github.com/stepfun-ai/Step-Code. As one markdown file: README.md.

Step Code

English · 简体中文

test.jpg

Swift execution, long-horizon reliability, and high token efficiency.


Step Code runs in your terminal and handles the full task loop—reading code, making changes, and running tests. It works with the Step provider and discovers the available Step models after sign-in. MCP servers, Agent Skills, plugins, and multi-agent orchestration work out of the box; you can delegate long-running tasks to /goal and let Step Code drive them forward autonomously.

Step Code comes with built-in StepPage publishing. Once your local page is ready, you can publish it as an accessible static website with a single command—bringing development, debugging, and delivery all within the same terminal.

StepPage publishing demo

Why Step Code

Installation

Pick the official installer for your platform. It downloads the latest release, verifies the checksum, installs step to ~/.stepcode/bin, and updates your PATH; reopen your terminal and you are done.

macOS / Linux / WSL

curl -fsSL https://static-openapi.stepfun.com/stepcode/install.sh | bash

Windows (PowerShell)

irm https://static-openapi.stepfun.com/stepcode/install.ps1 | iex
step --version
step --help

Upgrade later with step update.

Sign in to the Step provider

The default Step Code entrypoint exposes one built-in model provider: Step (StepFun). The profiles below select the Step service region and billing method; they are not separate providers.

Profile Credential Billing
Step Plan (CN, platform.stepfun.com) Browser OAuth; credentials refresh automatically Usage included with Mini / Plus / Pro / Max plans
Step Plan Oversea (platform.stepfun.ai) Browser OAuth; credentials refresh automatically Usage included with Mini / Plus / Pro / Max plans
Step Platform (CN) API key from platform.stepfun.com/interface-key Pay per request
Step Platform Oversea API key from platform.stepfun.ai/interface-key Pay per request

Inside the TUI, /login opens the Step sign-in flow; from a shell, run step login. For API-key access, set STEP_API_KEY=<your_step_api_key> or enter the key in /login; headless runs can also pass --api-key <your_step_api_key>.

/status shows the current session and model status. Use step login status (or step login status --json) to check the Step credential and its validity. Stored credentials live in ~/.stepcode/auth.json with mode 0600; /logout clears the Step credential. After sign-in, /model lists the models discovered from the active Step endpoint.

Getting started

Change into your project directory:

cd /path/to/your/project
step

Describe the task in the TUI, or submit one at launch:

step -p "What is the tech stack of this project? What is each directory responsible for? How do I run it locally?"

Run /init to generate an AGENTS.md project guide; an existing CLAUDE.md is used as-is.

Entry Command Use case
Interactive TUI step Exploring code, ongoing conversations, reviewing changes
Headless step -p "..." Scripts, CI, batch jobs

Examples

Start the TUI in any project and enter:

What is the tech stack of this project? What is each directory responsible for? How do I run it locally? Don't modify any files yet.

Then one that makes changes:

Create a reference table for the error codes in src/api/errors.ts (code, meaning, trigger scenario) and save it to docs/errors.md

Resume a session

step -c   # Continue the most recent session
step -r   # Browse session history and pick one to resume

Inside the TUI, /resume finds past sessions and /hotkeys lists all shortcuts.

Common shortcuts

Key Action
Enter Send message
Shift+Enter / Ctrl+J / Alt+Enter Newline
Enter Queue a message while streaming (delivered after the current tool call finishes)
@ Reference a project file
!command Run a shell command and hand the output to the model
Shift+Tab Cycle permission mode
Ctrl+O Toggle tool output
Esc Interrupt the running task

Migrate from other agents

Build from source

Developing Step Code or running from this repository requires Git, Node.js, and pnpm:

git clone https://github.com/stepfun-ai/Step-Code.git
cd Step-Code
pnpm install --ignore-scripts
pnpm run build
pnpm step

When running from the source tree, replace step with pnpm step.

Security

Uninstall

Make sure no step sessions are running before you uninstall.

Remove the binary: delete the step executable from the install directory (default ~/.stepcode/bin). The installer appends a PATH block marked # stepcode to your shell config; removing that block completes the uninstall (zsh: ~/.zshrc, bash: ~/.bashrc, fish: the fish_add_path config).

Remove user data (optional): everything lives under ~/.stepcode (config, credentials, sessions, logs); delete the directory to remove all Step Code data:

rm -rf ~/.stepcode

Docs & community

License

Released under the MIT license; see LICENSE.

Step-Code (stepfun-ai/Step-Code)

Searching Database…

这是干什么的?Step Code 是 StepFun 推出的终端 AI 编程助手:登录后它会使用 Step 模型,在你的项目里完成整个任务流程——读代码、改代码、跑测试。
它是交互式的终端程序,还是可以自己独立运行?两者都可以:step 会打开交互式 TUI,方便浏览代码和检查改动;而 step -p '任务文本' 则以无界面方式运行,适合脚本、CI 和批处理任务。/resume 可以找回过去的会话。
怎么把它装到我的电脑上?运行适合你系统的官方安装器(macOS、Linux/WSL 或 Windows PowerShell):它会下载最新版本、校验 checksum、把 step 安装到 ~/.stepcode/bin 并更新你的 PATH。以后升级只需运行 step update。
我需要 Step 账号吗,还是可以用 API key?两种都行:可以用 Step Plan 账号登录(通过浏览器 OAuth,Mini/Plus/Pro/Max 套餐都包含用量),也可以使用按请求计费的 Step Platform API key。两者都分国内版和海外版(stepfun.com / stepfun.ai)。
它现在在 Windows 上好用吗?能运行,但 PowerShell 支持还处于 beta 阶段,所以 README 建议在 WSL 下安装。安装器还提供 --version(锁定版本)和自定义 --install-dir 等参数。
它可以搭配哪些模型使用?只能用 Step(StepFun)的模型:默认入口只接这一个供应商,登录后 /model 会列出当前 Step 端点上发现的模型。没有自带其他供应商的选项。
StepPage 是什么?它是内置的发布插件:一条命令就能把本地目录变成可分享的静态 URL,还带版本管理和回滚功能,开发、调试和交付都在同一个终端里完成。
Step Code 把我的凭证和数据存在哪里?所有内容都存放在 ~/.stepcode 下(配置、凭证、会话、日志)。凭证保存在权限为 0600 的 auth.json 里,/logout 可以清除它们,删掉整个目录即可移除所有 Step Code 数据。
Creator
stepfun-ai
Size
7.5 MB
Stars
971
Updated
CommitOct 16
Age
4mo
Commits · 90 Days