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

# Quickstart

Step Code works with files in your project directory to complete development tasks. See [Step Code overview](https://platform.stepfun.ai/docs/en/step-code/overview.md) for capabilities and use cases.

## Prerequisites

* A Step Plan account or Step API key, and network access to the model service.
* A project containing a `README.md` that you are authorized to share with the selected model service.

## Installation

> [!NOTE]
>
> The commands execute a remote script. Verify the source first. To pin a version or uninstall, see [Updates](https://platform.stepfun.ai/docs/en/step-code/installation.md).

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

> [tab] Windows PowerShell
>
> ```powershell theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
> irm https://static-openapi.stepfun.com/stepcode/install.ps1 | iex
> ```
>
> PowerShell support is in beta. You can also use the Linux command in WSL.

Open a new terminal and run `step --version`. Confirm that it prints the installed version.

## First launch

Open your project, replacing the example path with its actual location:

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

Follow the startup prompts to sign in and choose a theme. If Step Code detects MCP configuration from another tool, it offers to import it. See [Migrating from other tools](https://platform.stepfun.ai/docs/en/step-code/guides/migration.md) for reuse options.

## Login

1. Enter `/login` in the interactive input box.
2. Select the Step sign-in option for your account and billing channel. Choose Step Plan for a subscription on `platform.stepfun.com`, or Step Plan Oversea for one on `platform.stepfun.ai`, and authorize in the browser. For API keys, choose the Step account option that matches the key.
3. Run `/model` and select a model available to the account.

In an SSH, server, or container terminal, run `step login --no-browser` to get an authorization link, then complete sign-in in a browser on this or another device. The command still requires an interactive terminal and does not depend on a local callback port.

Subscription and pay-as-you-go requests use separate channels. See [Authentication and models](https://platform.stepfun.ai/docs/en/step-code/configuration/models.md) for endpoints, sign-in details, and other providers.

## Check permissions

New interactive sessions without a configured permission mode default to Approve for Me: routine operations run automatically, while detected dangerous or unanalyzable commands still require confirmation. When you want confirmation before file changes and commands, run `/permissions` and choose Ask. Permission modes are not an OS sandbox; run Step Code only in directories you trust. See [Permissions and safety](https://platform.stepfun.ai/docs/en/step-code/guides/permissions.md) for mode behavior and project access boundaries.

## Your first conversation

Reference `README.md` in the input box and send a task:

```text theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
@README.md Identify this project's purpose, startup instructions, and test commands. Mark missing details as "not documented". Do not modify files or execute commands.
```

## Check the result

Compare the answer with the README. Confirm that it identifies documented commands rather than inventing missing setup steps, and inspect tool activity for actions outside the task. In a Git project, use `git diff` to inspect file changes.

Use `/quit` to exit. To continue the same task later, see [Sessions and context](https://platform.stepfun.ai/docs/en/step-code/guides/sessions.md).

## Next steps

* [Project instructions](https://platform.stepfun.ai/docs/en/step-code/customization/project-instructions.md): record team conventions and verification requirements.
* [Interaction and task control](https://platform.stepfun.ai/docs/en/step-code/guides/interaction.md): reference images, plan work, and manage goals or scheduled tasks.
* [Slash commands](https://platform.stepfun.ai/docs/en/step-code/reference/slash-commands.md) and [Keyboard shortcuts](https://platform.stepfun.ai/docs/en/step-code/reference/keyboard-shortcuts.md): look up available operations.
* [Data paths](https://platform.stepfun.ai/docs/en/step-code/configuration/data-paths.md): locate, back up, or clean up credentials, settings, and sessions.
* [Updates](https://platform.stepfun.ai/docs/en/step-code/installation.md): update the program, select a release, or uninstall. See [Release notes](https://platform.stepfun.ai/docs/en/step-code/release-notes.md) for version changes.


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