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…

931 ·GitHub
Step-Code
What is this?Step Code is a terminal-based AI coding agent from StepFun: it handles the full task loop in your project — reading code, making changes, running tests — using Step models after you sign in.
Is it an interactive terminal app, or can it run on its own?Both: step opens the interactive TUI for exploring code and reviewing changes, while step -p 'task text' runs headless — suited to scripts, CI, and batch jobs. /resume finds past sessions.
How do I get it onto my machine?Run the official installer for your platform (macOS, Linux/WSL, or Windows PowerShell): it downloads the latest release, verifies the checksum, installs step to ~/.stepcode/bin and updates your PATH. Later upgrades are just step update.
Do I need a Step account, or can I use an API key?Either: sign in with a Step Plan account (browser OAuth, usage included with Mini/Plus/Pro/Max plans) or use a Step Platform API key billed per request. Both come in Chinese and overseas variants (stepfun.com / stepfun.ai).
Does it work well on Windows right now?It runs, but PowerShell support is still beta, so the README recommends installing under WSL instead. Installer flags cover pinning --version and a custom --install-dir.
Which models can I use with it?Only Step (StepFun) models: the default entrypoint exposes that single provider, and /model lists the models discovered from the active Step endpoint after sign-in. There is no bring-your-own-provider option.
What is StepPage?The built-in publishing plugin: one command turns a local directory into a shareable static URL, with version management and rollback, so development, debugging, and delivery stay inside the same terminal.
Where does Step Code keep my credentials and data?Everything lives under ~/.stepcode (config, credentials, sessions, logs). Credentials sit in auth.json with mode 0600, /logout clears them, and deleting the directory removes all Step Code data.
What are similar projects?autoprompt-skill, pstack-claude, open-pstack, claude-code, deer-flow, openrig, Baize, maki
Which topics is it in?token-optimization, subagents, installer, autonomous-agents, tui, agent-orchestration, multi-agent, coding-agent, plugin, agent-skills, ai-agent, claude-code
Creator
stepfun-ai
Size
7 MB
Stars
931
Updated
CommitOct 16
Age
4mo
Commits · 90 Days