---
title: "while.sh docs: your agent, your apps, every building block"
url: https://while.sh/en/docs/
updated: 2026-11-09
---

# The while docs

These docs tell you, and your agent, how to deploy an app with while: where to start, what each building block does, and the full reference.

- [Your agent works in a terminal Claude Code, Codex, Cursor, Gemini CLI or VS Code: one command connects them all.](https://while.sh/en/docs/get-started/connect-your-agent/#in-a-terminal)
- [Your agent is a conversation Claude, ChatGPT or Mistral Vibe: a connector is all it takes.](https://while.sh/en/docs/get-started/connect-your-agent/#in-a-conversation)
- [Without an account Your agent deploys your app as a trial, in one request.](https://while.sh/en/docs/get-started/try-without-an-account/)

[The while docs](https://while.sh/en/docs/)

Get started

- [Connect your agent](https://while.sh/en/docs/get-started/connect-your-agent/)
- [Try without an account](https://while.sh/en/docs/get-started/try-without-an-account/)
- [Your first deployment](https://while.sh/en/docs/get-started/first-deployment/)
- [How while works](https://while.sh/en/docs/get-started/how-while-works/)
- [What your app must follow](https://while.sh/en/docs/get-started/the-while-contract/)

Building blocks

Applications

- [Web services](https://while.sh/en/docs/building-blocks/web-service/)
- [Workers](https://while.sh/en/docs/building-blocks/worker/)
- [Scheduled jobs](https://while.sh/en/docs/building-blocks/scheduled-jobs/)
- Courriels
- [Data projects](https://while.sh/en/docs/building-blocks/data-projects/)
- [Prebuilt images](https://while.sh/en/docs/building-blocks/prebuilt-image/)
- [Git repository](https://while.sh/en/docs/building-blocks/git/)
- [Sleep](https://while.sh/en/docs/building-blocks/sleep/)
- [Static sites](https://while.sh/en/docs/building-blocks/static-site/)

Data

- [PostgreSQL databases](https://while.sh/en/docs/building-blocks/postgres/)
- [Read another project's database](https://while.sh/en/docs/building-blocks/read-another-database/)
- [Valkey cache (Redis)](https://while.sh/en/docs/building-blocks/valkey/)
- [Object storage (S3)](https://while.sh/en/docs/building-blocks/s3/)
- [Tested backups](https://while.sh/en/docs/building-blocks/backups/)

Network and domains

- [Private network](https://while.sh/en/docs/building-blocks/private-network/)
- [HTTPS address](https://while.sh/en/docs/building-blocks/https-address/)
- [Custom domain](https://while.sh/en/docs/building-blocks/custom-domains/)
- [Outbound traffic](https://while.sh/en/docs/building-blocks/outbound-traffic/)
- [API connections](https://while.sh/en/docs/building-blocks/api-connections/)

Security and access

- [Federated connections](https://while.sh/en/docs/building-blocks/federated-connections/)
- [Variables and secrets](https://while.sh/en/docs/building-blocks/secrets/)
- [Internal access](https://while.sh/en/docs/building-blocks/internal-access/)
- [Roles and permissions](https://while.sh/en/docs/building-blocks/roles/)
- [Isolation](https://while.sh/en/docs/building-blocks/isolation/)
- [Security](https://while.sh/en/docs/building-blocks/security/)
- [Dependency vulnerabilities](https://while.sh/en/docs/building-blocks/vulnerabilities/)

Logs and errors

- [Logs](https://while.sh/en/docs/building-blocks/logs/)
- [Metrics](https://while.sh/en/docs/building-blocks/metrics/)
- [Errors (Sentry)](https://while.sh/en/docs/building-blocks/errors/)
- [OpenTelemetry](https://while.sh/en/docs/building-blocks/opentelemetry/)
- [Events](https://while.sh/en/docs/building-blocks/events/)

Versions

- [Plan](https://while.sh/en/docs/building-blocks/plan/)
- [Versions and rollback](https://while.sh/en/docs/building-blocks/rollback/)
- [Previews](https://while.sh/en/docs/building-blocks/previews/)

Reference

- [while.yaml](https://while.sh/en/docs/reference/while-yaml/)
- [MCP tools](https://while.sh/en/docs/reference/mcp-tools/)
- [The API](https://while.sh/en/docs/reference/api/)
- [Limits and quotas](https://while.sh/en/docs/reference/limits/)
- [Pricing](https://while.sh/en/pricing/)

Guides

- [Connect your agent](https://while.sh/en/guides/#rubrique-1)
- [Leave another host](https://while.sh/en/guides/#rubrique-2)
- [Deploy your app](https://while.sh/en/guides/#rubrique-3)
- [Host an open-source tool](https://while.sh/en/guides/#rubrique-4)
- [Deploy an API](https://while.sh/en/guides/#rubrique-5)
- [All guides](https://while.sh/en/guides/)