# Shardflux Docs

> Shardflux gives AI agents cloud computers: persistent, isolated microVM workspaces opened by key that suspend, resume and fork.

Every page below is Markdown; the HTML version is the same URL without `.md`.

## Get started

- [Overview](https://docs.shardflux.dev/index.md): Shardflux gives AI agents cloud computers: persistent, isolated microVM workspaces opened by key that suspend, resume and fork.
- [Quickstart](https://docs.shardflux.dev/quickstart.md): Create a Shardflux account and API key, then open a persistent workspace, run a command and check that a file survives suspend.
- [Support and bug reports](https://docs.shardflux.dev/support.md): Report Shardflux bugs, request features, and get help with packages, workspaces, account access, billing, or security vulnerabilities.

## Concepts

- [Workspaces](https://docs.shardflux.dev/concepts/workspaces.md): Shardflux workspaces: keys, organizations and projects, API keys and tool tokens, persistent and session lifetimes, sharing and attribution.
- [Lifecycle](https://docs.shardflux.dev/concepts/lifecycle.md): Open, suspend, resume, fork, reset and delete Shardflux workspaces: states, idle suspend and parking, waiting, and what survives each transition.
- [File-first workspaces](https://docs.shardflux.dev/concepts/file-first.md): File-first workspaces keep a versioned file tree and run each command in a fresh VM: executions, tree revisions, limits, and when to choose them.
- [Templates](https://docs.shardflux.dev/concepts/templates.md): Shardflux templates: versioned images that workspaces start from, with environment, inputs, start commands and services, and python-node-browser.

## Guides

- [Use Shardflux with your coding agent](https://docs.shardflux.dev/guides/coding-agents.md): A prompt for your coding agent, an account from the shard CLI without a browser, and MCP server setup for Claude Code, Cursor, Codex and Claude Desktop.
- [Give your agent workspace tools](https://docs.shardflux.dev/guides/agent-tools.md): Give your agent a Shardflux workspace: workspace tools in TypeScript and Python for Anthropic, OpenAI and other frameworks, scheduled runs, tool-call capture.
- [Search and edit files](https://docs.shardflux.dev/guides/files.md): Search file contents, edit files with patches that check the file's revision, and read a suspended workspace's files without waking it.
- [Build a template](https://docs.shardflux.dev/guides/build-a-template.md): Build your own Shardflux template from template.yaml: languages, packages, files, build steps, start commands and services, with the CLI, SDKs or MCP.

## Reference

- [TypeScript SDK](https://docs.shardflux.dev/reference/typescript.md): Reference for @shardflux/sdk 0.10.2 for Node.js 24+. Workspaces by key, commands, files, lifecycle, templates, agent tools and the account plane.
- [Python SDK](https://docs.shardflux.dev/reference/python.md): Reference for the shardflux Python package 0.6.0 (Python 3.10+). Workspaces, commands, files, templates, agent tools, capture and the account plane.
- [CLI](https://docs.shardflux.dev/reference/cli.md): Reference for the shard command line (@shardflux/cli 0.5.3, shardflux npm bundle 0.7.2). Account, sign-in, billing, workspaces, environment and exit codes.
- [MCP server](https://docs.shardflux.dev/reference/mcp.md): Reference for @shardflux/mcp 0.4.3, the local stdio MCP server. Client setup, environment variables, every tool and its arguments, wake, errors and updates.
- [HTTP API](https://docs.shardflux.dev/reference/http-api.md): Shardflux HTTP API reference. Base URL, /v1 versioning, API keys, people's sessions, tool tokens, idempotency, pagination, operations, rate limits and cells.
- [HTTP API endpoints](https://docs.shardflux.dev/reference/http-api/endpoints.md): Every public Shardflux HTTP API operation by resource: method, path, authentication, parameters and request fields, from openapi.json.
- [Errors](https://docs.shardflux.dev/reference/errors.md): The Shardflux error envelope and every error code and details.reason the API and the cell gateway return, with HTTP status, meaning and what to do.
- [Pricing and limits](https://docs.shardflux.dev/limits.md): Shardflux plans and allowances, what happens at a limit, opt-in overage with a spend cap, workspace sizes, region, rate limits and file and command limits.

## Optional

- [Full documentation](https://docs.shardflux.dev/llms-full.txt): every page above in one Markdown file, in this order
- [OpenAPI document](https://docs.shardflux.dev/openapi.json): the public HTTP API (OpenAPI 3.1)
- [Agent guide](https://shardflux.dev/agents.md): when Shardflux fits a task, limits, pricing and a complete example