# Amp

Amp is a coding agent and development environment built for the frontier.

This is an index of the Amp documentation for agents and other programmatic readers.
Each link below serves the raw Markdown rendition of a page.
The human-readable HTML version of a page is at https://ampcode.com/docs with the
`/markdown` path segment removed (for example https://ampcode.com/docs/prompting).

## Get Started

- [Introduction](https://ampcode.com/docs/markdown): Amp is a coding agent and development environment built for the frontier. Learn what Amp does, install it, and run your first agent.
- [The Dial](https://ampcode.com/docs/markdown/the-dial): Choose a mode, tune its models, and add your own agents to the dial.
- [Modes & Models](https://ampcode.com/docs/markdown/models-and-subagents): Understand the models and specialist agents Amp uses.
- [Prompting](https://ampcode.com/docs/markdown/prompting): Write prompts and work with messages, files, and other threads.
- [Designing UI](https://ampcode.com/docs/markdown/designing-ui): Explore UI designs from screenshots, refine a direction, and build it in your app.
- [Tools](https://ampcode.com/docs/markdown/tools): Understand the tools Amp uses to inspect and change your code.
- [Projects](https://ampcode.com/docs/markdown/projects): Connect a repository to Amp settings, secrets, and threads.
- [GitHub & Git](https://ampcode.com/docs/markdown/github): Connect GitHub and learn how orbs clone, commit, push, and sign.
- [Threads](https://ampcode.com/docs/markdown/threads): Start, continue, share, and organize conversations with the agent.
- [Pricing](https://ampcode.com/docs/markdown/pricing): Understand plans, credits, and usage.

## Orbs

- [Overview](https://ampcode.com/docs/markdown/orbs): Learn how Amp runs work in remote environments.
- [Getting Started](https://ampcode.com/docs/markdown/orbs/getting-started): Set up a project and start your first orb.
- [Customizing Orbs](https://ampcode.com/docs/markdown/orbs/customizing): Prepare every new orb for your project.
- [Shipping Changes](https://ampcode.com/docs/markdown/orbs/shipping): Choose how the agent lands changes and customize the Ship prompt.
- [Sizes & Costs](https://ampcode.com/docs/markdown/orbs/sizes-and-costs): Choose the right compute size and understand billing.
- [Handling Secrets](https://ampcode.com/docs/markdown/orbs/handling-secrets): Give orbs secure access to private services.
- [Files & Attachments](https://ampcode.com/docs/markdown/orbs/files-and-attachments): Give Amp images, videos, logs, documents, and datasets.
- [Portals](https://ampcode.com/docs/markdown/orbs/portals): Share services that are running inside an orb.
- [Agent to Agent](https://ampcode.com/docs/markdown/orbs/agent-to-agent): Delegate work between agents and exchange results.
- [Automations](https://ampcode.com/docs/markdown/orbs/automations): Run Amp on a schedule or at a specific time.
- [Event-Driven Orbs](https://ampcode.com/docs/markdown/orbs/event-driven): Start work when an external event happens.
- [Desktop](https://ampcode.com/docs/markdown/orbs/desktop): Use browsers and other graphical apps inside an orb.

## CLI

- [Getting Started](https://ampcode.com/docs/markdown/cli): Install Amp and use the CLI.
- [Keybindings](https://ampcode.com/docs/markdown/cli/keybindings): Learn and customize CLI keyboard shortcuts.
- [Execute Mode](https://ampcode.com/docs/markdown/cli/execute-mode): Run Amp from scripts and commands.
- [Spawning Orbs](https://ampcode.com/docs/markdown/cli/spawning-orbs): Start and continue orb threads from the terminal with amp -ox.
- [Streaming JSON](https://ampcode.com/docs/markdown/cli/streaming-json): Use the CLI from programs and scripts.
- [Configuration](https://ampcode.com/docs/markdown/cli/settings): Configure Amp for yourself or a workspace.
- [Runners](https://ampcode.com/docs/markdown/cli/runners): Run remotely created threads on your own machine.
- [Cross-Client Access](https://ampcode.com/docs/markdown/cli/remote-control): Continue a running CLI thread across clients.

## macOS & iOS

- [Getting Started](https://ampcode.com/docs/markdown/macos-and-ios): Install Amp on your Mac, iPhone, and iPad to control orbs from anywhere.

## Puck

- [Meet Puck](https://ampcode.com/docs/markdown/puck): Launch and coordinate agents with Puck.
- [Slack Integration](https://ampcode.com/docs/markdown/puck/slack-integration): Use your personal Puck from Slack.

## Collaborate

- [Workspaces](https://ampcode.com/docs/markdown/collaborate/workspaces): Connect your team with shared threads and pooled billing.
- [Groups](https://ampcode.com/docs/markdown/collaborate/groups): Share threads and assign entitlements to part of a workspace.
- [Multiplayer](https://ampcode.com/docs/markdown/collaborate/multiplayer): Work with other people in the same Amp thread and orb.
- [Space](https://ampcode.com/docs/markdown/collaborate/space): Talk with your team in a voice and video call inside every thread.

## Customize

- [Plugins](https://ampcode.com/docs/markdown/customize/plugins): Add tools and other behavior with plugins.
- [Global Plugins & Skills](https://ampcode.com/docs/markdown/customize/global-plugins-and-skills): Use, share, and publish extensions everywhere Amp runs.
- [Skills](https://ampcode.com/docs/markdown/customize/skills): Teach Amp repeatable ways to complete tasks.
- [MCP](https://ampcode.com/docs/markdown/customize/mcp): Connect Amp to MCP servers.
- [AGENTS.md](https://ampcode.com/docs/markdown/customize/agents-md): Give Amp durable guidance for your codebase.
- [Model Routing](https://ampcode.com/docs/markdown/customize/model-routing): Serve models through your own keys, subscriptions, and gateways, in the order you choose.

## Reference

- [SDK: Overview](https://ampcode.com/docs/markdown/sdk): Use Amp from your own programs.
- [SDK: TypeScript](https://ampcode.com/docs/markdown/sdk/typescript): Use the TypeScript SDK.
- [SDK: Python](https://ampcode.com/docs/markdown/sdk/python): Use the Python SDK.
- [Plugin API](https://ampcode.com/docs/markdown/plugin-api): The generated `@ampcode/plugin` type reference and an end-to-end example plugin.

## Support

- [Getting Help](https://ampcode.com/docs/markdown/support/getting-help): Contact support and check platform and service status.
- [Bug Reports & Diagnostics](https://ampcode.com/docs/markdown/support/reporting-bugs): Report bugs and share diagnostics with Amp.

## Enterprise

- [Self-Hosted Orbs](https://ampcode.com/docs/markdown/orbs/self-hosted): Compare Amp-hosted orbs with orbs that run in your own cloud.
- [MCP Registry Allowlist](https://ampcode.com/docs/markdown/enterprise/mcp-registry-allowlist): Limit workspace members to approved MCP servers.
- [Thread Visibility](https://ampcode.com/docs/markdown/enterprise/workspace-thread-visibility-controls): Control how workspace members share threads.
- [Workspace Entitlements](https://ampcode.com/docs/markdown/enterprise/workspace-entitlements): Set per-user usage quotas for a workspace.
- [Minimal Data Retention](https://ampcode.com/docs/markdown/enterprise/minimal-data-retention): Limit data retention by third-party model providers.