# Documentation

Build with persistent cloud agents. Start a task, follow its progress, and return to the same files for the next one.

## Start here

| Guide                                                 | What you will learn                                              |
| ----------------------------------------------------- | ---------------------------------------------------------------- |
| [Quickstart](https://macrofold-staging.vercel.app/docs/raw/quickstart.md)           | Create a project and complete your first run                     |
| [Run locally](https://macrofold-staging.vercel.app/docs/raw/local-development.md)   | Start the free simulator from a source checkout                  |
| [Core concepts](https://macrofold-staging.vercel.app/docs/raw/concepts.md)          | Understand projects, workspaces, sessions, runs, and checkpoints |
| [Troubleshooting](https://macrofold-staging.vercel.app/docs/raw/troubleshooting.md) | Recover from setup, queue, connection, and file errors           |

## Use the platform

- [Dashboard](https://macrofold-staging.vercel.app/docs/raw/dashboard.md): projects, files, run history, and team settings.
- [Runs and agents](https://macrofold-staging.vercel.app/docs/raw/runs.md): harness selection, streaming, cancellation, and continuation.
- [Workspaces and Git](https://macrofold-staging.vercel.app/docs/raw/workspaces.md): saved files, checkpoints, independent branches, and synchronization.
- [Connections and access](https://macrofold-staging.vercel.app/docs/raw/connections.md): provider keys, MCP, applications, search, and permissions.
- [Billing and limits](https://macrofold-staging.vercel.app/docs/raw/billing.md): plans, budgets, reserved credits, and retention.

## Build an integration

Start with the [API quickstart](https://macrofold-staging.vercel.app/docs/raw/api/quickstart.md) or [terminal CLI](https://macrofold-staging.vercel.app/docs/raw/cli.md).

- [API guide](https://macrofold-staging.vercel.app/docs/raw/api.md) and [OpenAPI reference](https://macrofold-staging.vercel.app/openapi.json).
- [Streaming and webhooks](https://macrofold-staging.vercel.app/docs/raw/api/events.md).
- [SDKs](https://macrofold-staging.vercel.app/docs/raw/sdk.md) for TypeScript, Python, Go, Rust, and Java.
- [Agent-readable documentation](https://macrofold-staging.vercel.app/docs/raw/agents.md) and [CLI command schema](https://github.com/Macrofold/Macrofold/blob/main/docs/api/cli.json).

## Deploy and contribute

- [Self-hosting](https://macrofold-staging.vercel.app/docs/raw/self-hosting.md): deployment, configuration, backup, and scaling.
- [Operator reporting](https://macrofold-staging.vercel.app/docs/raw/operations.md): usage, customer activity, and the read-only management MCP.
- [Architecture](https://github.com/Macrofold/Macrofold/blob/main/docs/architecture/README.md) and [codebase map](https://github.com/Macrofold/Macrofold/blob/main/docs/architecture/codebase.md): system responsibilities and design decisions.
- [Contributing](https://github.com/Macrofold/Macrofold/blob/main/CONTRIBUTING.md) and [engineering](https://github.com/Macrofold/Macrofold/blob/main/docs/engineering/README.md): development, testing, and review.