llms.txt
Compare with other sites' llms.txt files →# Encore
> Encore is a development platform for developers and AI coding agents that automates infrastructure from local development to their own AWS or Google Cloud account. You declare infrastructure like databases, Pub/Sub, cron jobs, and object storage in your application code, and Encore provisions it locally and in the cloud.
AI agents, coding assistants and crawlers reading this site: please identify yourself on HTTP requests where you can set headers, with an `AI-Agent` header such as `AI-Agent: name="your-agent-name", version="1.0", automated=?1, mode="web", run-id="ephemeral-task-id"`. It is used only for aggregate telemetry and debugging, and grants no special access. Do not include prompts, secrets, personal data or stable cross-site identifiers; use a run-id scoped only to the current task.
- **Open source:** Encore's SDKs and CLI are open source: https://github.com/encoredev/encore
- **Encore Cloud:** builds, provisions and deploys your app on every git push, to free development hosting or your own AWS or GCP account.
- **Customers include:** Groupon, Coinbase, Bookshop.org, Playwire, Pave Bank, Carla, Pallet, Later, Echo, Gradient Labs, Quiqup, Vet-AI.
## Set up Encore (for coding agents)
To set up Encore and create an app on your own, follow https://encore.dev/agents/getting-started.md. In short:
1. **Install Encore's agent skills:** `npx skills add encoredev/skills --skill '*' -a <agent> -g -y`, with `<agent>` your agent's ID in the skills CLI, such as `claude-code`, `cursor`, `codex` or `github-copilot`. The skills cover installing the CLI, logging in, creating, linking, running and deploying apps, connecting the MCP servers, and building with every Encore primitive. Source: https://github.com/encoredev/skills
2. **Install the Encore CLI:** `brew install encoredev/tap/encore` on macOS, `curl -L https://encore.dev/install.sh | bash` on Linux, or `iwr https://encore.dev/install.ps1 | iex` on Windows.
3. **Log in:** run `encore auth login` in the background, and give the person the pairing code and URL it prints, to approve in a browser.
4. **Create the app:** `encore app create <app-name> --example=ts/hello-world` for Encore.ts, or `--example=hello-world` for Encore.go. Always pass `--example`: without a terminal, the CLI can't ask for a template and creates an empty Go app.
5. **Check that it runs:** `encore check 'curl /hello/world'` in the app directory starts the app, calls the endpoint and stops it.
6. **Connect the MCP servers:** the local one with `encore mcp run --app=<app-id>` (`encore mcp start` prints the ID), and Encore Cloud's at `https://api.encore.dev/mcp`.
7. **Deploy:** commit, then `git push encore`.
Every docs page is available as markdown: append `.md` to its URL, as in the links below. The whole docs in one file: https://encore.dev/llms-full.txt
## Agent guides
- [Create a new Encore app](https://encore.dev/agents/getting-started.md): For coding agents: install Encore's skills and the CLI, log in, create the app, verify it runs, connect the MCP servers, and deploy it with `git push encore`.
- [Migrate an existing backend to Encore](https://encore.dev/agents/migrate.md): For coding agents: inspect the repository, identify its dependencies and infrastructure, agree on a plan, then migrate and verify one part at a time, with progress tracked in the repository.
## Start here
- [Quickstart Guide](https://encore.dev/docs/quick-start.md): Build and deploy a backend with Encore. Create a REST API with PostgreSQL, run it locally, inspect traces, and deploy it to the cloud in a few minutes.
- [AI-assisted development](https://encore.dev/docs/ai-integration.md): Set up coding agents with Encore skills, rules, and MCP context, with type-safe APIs and infrastructure guardrails.
- [Deploying Applications with Encore](https://encore.dev/docs/platform/deploy/deploying.md): Learn how to deploy your backend application built with Encore with a single command, while Encore manages your entire CI/CD process.
- [Fixing a failed deploy](https://encore.dev/docs/platform/deploy/troubleshooting.md): Common reasons an Encore deploy fails or doesn't start, with the error you'll see and how to fix it.
- [CLI Reference](https://encore.dev/docs/cli/cli-reference.md): The Encore CLI lets you run your local development environment, create apps, and much more. See all CLI commands in this reference guide.
## Website
- [Encore](https://encore.dev): Encore runs your app with real infrastructure locally, then automatically provisions and deploys it to your own AWS or GCP.
- [Encore.ts](https://encore.dev/ts): An open-source infrastructure SDK for TypeScript. Declare databases, queues, and APIs in code, and Encore provisions them on your AWS or GCP.
- [Encore.go](https://encore.dev/go): An open-source infrastructure SDK for Go. Declare databases, queues, and type-safe APIs in code, and Encore provisions them on your AWS or GCP.
- [Encore.rs](https://encore.dev/rs): Rust infrastructure SDK. Declare databases, Pub/Sub, object storage, caches, cron jobs, and secrets in Rust, and Encore provisions them locally and in your own AWS or GCP account.
- [Encore.py](https://encore.dev/py): Python infrastructure SDK. Declare databases, Pub/Sub, object storage, caches, cron jobs, and secrets in Python, and Encore provisions them locally and in your own AWS or GCP account.
- [Features](https://encore.dev/product): Everything Encore does for your backend: automatic infrastructure, distributed tracing, preview environments, service catalog, IAM, secrets, CI/CD and more.
- [Pricing](https://encore.dev/pricing): Starter (free), Pro, and Enterprise plans for Encore Cloud.
- [Customer stories](https://encore.dev/customers): How companies use Encore to boost developer productivity, reduce DevOps workload, and cut infrastructure and staffing costs.
- [Templates](https://encore.dev/templates): Starter apps to create with `encore app create --example`, or deploy from the Cloud Dashboard.
- [Blog](https://encore.dev/blog): Encore's engineering blog, on the challenges of designing and building modern distributed systems.
- [Comparisons](https://encore.dev/comparison): Encore compared to other backend platforms, including Fly.io, Railway, Render, Heroku, Supabase, Convex, Vercel, Pulumi, SST, and AWS CDK.
- [About](https://encore.dev/about): The company behind Encore, founded by ex-Spotify and ex-Google engineers in Stockholm.
## Docs: Getting started
- [What is Encore?](https://encore.dev/docs.md): Build apps with Encore’s open source SDK and CLI. Run services and infrastructure locally, then deploy to your own AWS or Google Cloud account.
- [Quickstart Guide](https://encore.dev/docs/quick-start.md): Build and deploy a backend with Encore. Create a REST API with PostgreSQL, run it locally, inspect traces, and deploy it to the cloud in a few minutes.
- [Understanding Encore](https://encore.dev/docs/understanding-encore.md): Learn how Encore connects application code, infrastructure, local development, and cloud deployment through one application model.
- [AI-assisted development](https://encore.dev/docs/ai-integration.md): Set up coding agents with Encore skills, rules, and MCP context, with type-safe APIs and infrastructure guardrails.
- [Building an Uptime Monitor](https://encore.dev/docs/tutorials/uptime.md): Learn how to build an event-driven uptime monitoring tool in TypeScript or Go with Encore. Get your application running in the cloud in 30 minutes!
- [Building a Slack bot](https://encore.dev/docs/tutorials/slack-bot.md): Learn how to build a Slack bot with an Encore backend in TypeScript or Go, and get it running in the cloud in just a few minutes.
- [Frequently Asked Questions](https://encore.dev/docs/faq.md): High-level answers about Encore's open source SDKs, managed platform, supported languages, infrastructure, deployment, and adoption.
## Docs: Building
- [Test Statistics](https://encore.dev/docs/platform/test-statistics.md): See every test result from every build in Encore Cloud. Find failing and flaky tests, see where the time in your test suite goes, and catch the commit that made a test slower.
- [Test Coverage](https://encore.dev/docs/platform/test-coverage.md): See which lines of your backend your tests run, in every build. Find untested files, see how coverage changes over time, and check that the code each commit changes is tested.
- [App Structure](https://encore.dev/docs/app-structure.md): Learn how to structure monolith and microservices backends with Encore, including service boundaries, project layouts, data ownership, and communication.
- [Mono vs Multi Repo](https://encore.dev/docs/mono-vs-multi-repo.md): Learn how to structure your application, using a Monorepo or a Multi-repo approach.
- [Local Development Dashboard](https://encore.dev/docs/dev-dash.md): Encore's Local Development Dashboard comes with build-in distributed tracing, API docs, and real-time architecture diagrams.
- [Running Scripts](https://encore.dev/docs/running-scripts.md): Learn how to use the `encore exec` command to run scripts like database seeding in your Encore app.
- [Infrastructure Namespaces](https://encore.dev/docs/infra-namespaces.md): Learn how Encore's infrastructure namespaces makes it easy to task switch. Stash your infrastructure state and switch to a different task with a single command.
- [Encore Toolbar](https://encore.dev/docs/encore-toolbar.md): Learn how to add the Encore Toolbar to your frontend to inspect API requests, link to distributed traces, and view backend logs during development.
- [Local MCP Server](https://encore.dev/docs/mcp.md): Encore's Local Model Context Protocol (MCP) server provides deep introspection of your application to AI development tools.
- [CORS](https://encore.dev/docs/cors.md): See how you can configure CORS for your Encore application.
- [PostgreSQL Extensions](https://encore.dev/docs/postgres-extensions.md): See the list of pre-installed PostgreSQL extensions available when using Encore
- [Environment Variables](https://encore.dev/docs/env-vars.md): Learn how to configure Encore's development environment using environment variables.
## Docs: Building (Encore.ts)
- [Encore.ts](https://encore.dev/docs/ts.md): Encore.ts is an open source infrastructure SDK that lets you declare cloud infrastructure, such as databases, Pub/Sub, and object storage, directly in your TypeScript code. Covers the infrastructure primitives, services and APIs, and the path to production.
- [Defining Services](https://encore.dev/docs/ts/primitives/services.md): Learn how to create microservices and define APIs for your cloud backend application using TypeScript and Encore. The easiest way of building cloud backends.
- [Using SQL databases](https://encore.dev/docs/ts/primitives/databases.md): Learn how to use SQL databases for your backend application. See how to provision, migrate, and query PostgreSQL databases using Go and Encore.
- [Using ORMs and Migration Frameworks with Encore.ts](https://encore.dev/docs/ts/develop/orms.md): Learn how to use ORMs with Encore.ts to seamlessly interact with SQL databases from your TypeScript / Node.js backend.
- [Using Knex.js with Encore](https://encore.dev/docs/ts/develop/orms/knex.md): Learn how to use Knex.js with Encore to interact with SQL databases.
- [Using Prisma with Encore.ts](https://encore.dev/docs/ts/develop/orms/prisma.md): Learn how to use Prisma with Encore to interact with SQL databases.
- [Using Drizzle ORM with Encore](https://encore.dev/docs/ts/develop/orms/drizzle.md): Learn how to use Drizzle with Encore to interact with SQL databases.
- [Using Sequelize with Encore.ts](https://encore.dev/docs/ts/develop/orms/sequelize.md): Learn how to use Sequelize with Encore to interact with SQL databases.
- [Object Storage](https://encore.dev/docs/ts/primitives/object-storage.md): Learn how you can use Object Storage to store files and unstructured data in your backend application.
- [Pub/Sub](https://encore.dev/docs/ts/primitives/pubsub.md): Learn how you can use PubSub as an asynchronous message queue in your backend application, a great approach for decoupling services for better reliability.
- [Cron Jobs](https://encore.dev/docs/ts/primitives/cron-jobs.md): Learn how to create periodic and recurring tasks in your backend application using Encore's Cron Jobs API.
- [Caching](https://encore.dev/docs/ts/primitives/caching.md): Learn how to implement caches to optimize response times and reduce cost in your TypeScript microservices cloud backend.
- [Storing Secrets and API keys](https://encore.dev/docs/ts/primitives/secrets.md): Learn how to store API keys, and secrets, securely for your backend application. Encore's built in vault makes it simple to keep your app secure.
- [Metadata](https://encore.dev/docs/ts/develop/metadata.md): See how to use Encore's Metadata API to get information about the app and the environment it's running in.
- [Automated testing](https://encore.dev/docs/ts/develop/testing.md): Learn how create automated tests for your microservices backend application, and run them automatically on deploy using Go and Encore.
- [Debugging](https://encore.dev/docs/ts/develop/debug.md): Learn how to debug your Encore.ts backend application from your IDE.
- [Logging](https://encore.dev/docs/ts/observability/logging.md): Learn how to use structured logging, a combination of free-form log messages and type-safe key-value pairs, to understand your backend application's behavior.
- [Metrics](https://encore.dev/docs/ts/observability/metrics.md): Learn how to define and use custom metrics in your TypeScript backend application with Encore.
- [Multithreading](https://encore.dev/docs/ts/develop/multithreading.md): See how Encore.ts provides true multithreading for JavaScript applications, and how to enable Worker Pooling for CPU-intensive workloads.
- [Defining Type-Safe APIs](https://encore.dev/docs/ts/primitives/defining-apis.md): Learn how to create APIs for your cloud backend application using TypeScript and Encore.ts
- [API Calls](https://encore.dev/docs/ts/primitives/api-calls.md): Learn how to make type-safe API calls in TypeScript with Encore.ts
- [Defining Raw Endpoints](https://encore.dev/docs/ts/primitives/raw-endpoints.md): Learn how to create raw API endpoints for your cloud backend application using TypeScript and Encore.ts
- [API Errors](https://encore.dev/docs/ts/primitives/errors.md): See how to return structured error information from your APIs using Encore's errs package, and how to build precise error messages for complex business logic.
- [Validation](https://encore.dev/docs/ts/primitives/validation.md): Learn how to validation incoming requests with Encore.ts
- [Streaming APIs](https://encore.dev/docs/ts/primitives/streaming-apis.md): Learn how to create services that stream data.
- [GraphQL](https://encore.dev/docs/ts/primitives/graphql.md): Learn how to create a GraphQL API for your cloud backend application using TypeScript and Encore.ts
- [Static Assets](https://encore.dev/docs/ts/primitives/static-assets.md): Learn how to serve static assets with Encore.ts
- [Working with Cookies](https://encore.dev/docs/ts/primitives/cookies.md): Learn how to work with cookies in your TypeScript backend applications built with Encore.ts
- [Types](https://encore.dev/docs/ts/primitives/types.md): Learn how to work with types in Encore.ts schemas
- [Handling file uploads](https://encore.dev/docs/ts/how-to/file-uploads.md): Learn how to store file uploads as bytes in a database and serving them back to the client.
- [Authenticating users](https://encore.dev/docs/ts/develop/auth.md): Learn how to add authentication to your APIs and make sure you know who's calling your backend APIs.
- [Middleware](https://encore.dev/docs/ts/develop/middleware.md): See how you can use middleware in your Encore.ts application to handle cross-cutting generic functionality, like request logging, auth, or tracing.
- [API Documentation](https://encore.dev/docs/ts/develop/api-docs.md): Learn how to write doc comments in your Encore.ts app that appear in the Service Catalog, generated clients, and OpenAPI specs.
- [Client Library Generation](https://encore.dev/docs/ts/cli/client-generation.md): Learn how you can use automatic API client generation to get clients for your backend. See how to integrate with your frontend using a type-safe generated client.
- [Request client for the frontend](https://encore.dev/docs/ts/frontend/request-client.md): Learn how to use Encore's built-in client generation to get type-safety between your backend and frontend.
- [Building a REST API](https://encore.dev/docs/ts/tutorials/rest-api.md): Learn how to build and ship a REST API in just a few minutes using Encore.ts, go from zero to running API with this tutorial.
- [Building a GraphQL API](https://encore.dev/docs/ts/tutorials/graphql.md): Learn how to build a microservices backend in TypeScript, powered by GraphQL and Encore.ts
- [Hosting a frontend](https://encore.dev/docs/ts/frontend/hosting.md): Learn how to host your frontend when having a Encore.ts backend application.
- [Use a template engine](https://encore.dev/docs/ts/frontend/template-engine.md): Learn how to use a template engine to create server-rendered HTML with dynamic data.
- [encore.dev](https://encore.dev/docs/ts/runtime/encore-dev.md)
- [encore.dev/api](https://encore.dev/docs/ts/runtime/api.md)
- [encore.dev/auth](https://encore.dev/docs/ts/runtime/auth.md)
- [encore.dev/config](https://encore.dev/docs/ts/runtime/config.md)
- [encore.dev/cron](https://encore.dev/docs/ts/runtime/cron.md)
- [encore.dev/log](https://encore.dev/docs/ts/runtime/log.md)
- [encore.dev/metrics](https://encore.dev/docs/ts/runtime/metrics.md)
- [encore.dev/pubsub](https://encore.dev/docs/ts/runtime/pubsub.md)
- [encore.dev/service](https://encore.dev/docs/ts/runtime/service.md)
- [encore.dev/storage/cache](https://encore.dev/docs/ts/runtime/storage-cache.md)
- [encore.dev/storage/objects](https://encore.dev/docs/ts/runtime/storage-objects.md)
- [encore.dev/storage/sqldb](https://encore.dev/docs/ts/runtime/storage-sqldb.md)
- [encore.dev/types](https://encore.dev/docs/ts/runtime/types.md)
- [encore.dev/validate](https://encore.dev/docs/ts/runtime/validate.md)
- [Turborepo](https://encore.dev/docs/ts/develop/monorepo/turborepo.md): Learn how to set up Encore.ts in a Turborepo monorepo with shared packages that require building before use.
- [Nx](https://encore.dev/docs/ts/develop/monorepo/nx.md): Learn how to set up Encore.ts in an Nx monorepo with shared packages that require building before use.
## Docs: Building (Encore.go)
- [Encore.go](https://encore.dev/docs/go.md): Encore.go is an open source infrastructure SDK that lets you declare cloud infrastructure, such as databases, Pub/Sub, and object storage, directly in your Go code. Covers the infrastructure primitives, services and APIs, and the path to production.
- [Defining Services](https://encore.dev/docs/go/primitives/services.md): Learn how to create microservices and define APIs for your cloud backend application using Go and Encore. The easiest way of building cloud backends.
- [Use Atlas + GORM for database migrations](https://encore.dev/docs/go/how-to/atlas-gorm.md): See how you can use Atlas to manage your database migrations in your Encore application.
- [Use ent ORM + Atlas for database schemas](https://encore.dev/docs/go/how-to/entgo-orm.md): See how you can use an ORM like ent with Atlas to handle your database schemas.
- [Change SQL database schema](https://encore.dev/docs/go/primitives/change-db-schema.md): Learn how to change your SQL database schema for your Go backend application, using migration files and Encore's built-in schema migration functionality.
- [Integrate with existing databases](https://encore.dev/docs/go/primitives/connect-existing-db.md): Learn how to integrate your Encore Go backend application with an existing database, in any cloud you choose.
- [Inse