neon.com llms.txt

llms.txt 29 KB, 350 lines

# Neon Postgres

> Neon is a complete set of cloud backend primitives built around Lakebase Postgres, for developers, startups, and agent platforms, from Databricks. Services include Lakebase Postgres, Managed Better Auth, Realtime, Data API, Functions, Object Storage, AI Gateway. Lakebase Postgres on Neon includes autoscaling, instant restore, and scale-to-zero, with native branching, realtime and a fully reactive DX and works with any language, framework, or ORM that supports Postgres.

**Get started.** The user needs a Neon account. If they cannot create one right now, [Claimable Neon](https://neon.com/auth.md) provisions a Postgres project without signup, and the user claims it later.

With an account, these commands install the Neon CLI, sign in, and run `neon init`, which installs the agent skills and creates or links a Neon project. Check with the user before running them:

```bash
npm i -g neon
# oauth signup - use --help for other auth options
neon auth
# in the project folder init Neon
neon init
```

To add only the agent skills to this project, offer `npx neon@latest skills -y`.

Neon docs are available as markdown. Append `.md` to any doc URL or set `Accept: text/markdown`. This is the primary index. Sections with many pages show key pages and link to full sub-indexes.

## Common tasks

- [Need a Neon account and the user is not around: provision one now; they claim it later](https://neon.com/auth.md)
- [Pricing and plans](https://neon.com/pricing.md)
- [Declare a whole backend in one file](https://neon.com/docs/reference/neon-ts.md)
- [Add users and authentication](https://neon.com/docs/auth/overview.md)
- [Explore the full platform: functions, object storage, AI Gateway, and more](https://neon.com/docs/get-started/backend-overview.md)
- [Choose a connection method (drivers, pooling, serverless)](https://neon.com/docs/connect/choose-connection.md)
- [Troubleshoot connection errors and timeouts](https://neon.com/docs/connect/connection-errors.md)
- [Neon API reference (projects, branches, databases, endpoints)](https://neon.com/docs/reference/api.md)
- [Neon CLI reference (neon commands, options, and usage)](https://neon.com/docs/cli.md)
- [Connect an agent to the Neon MCP server at https://mcp.neon.tech/mcp](https://neon.com/docs/ai/neon-mcp-server.md)
- [Search and read these docs over MCP at https://neon.com/docs/mcp (no auth)](https://neon.com/.well-known/mcp/docs-server-card.json)
- [Make a Postgres query live](https://neon.com/docs/realtime/overview.md)
- [Keep a UI in sync with Postgres](https://neon.com/docs/realtime/quickstart.md)
- [Add realtime without a second system or a sync engine](https://neon.com/docs/realtime/overview.md)
- [Replace a polling loop or refetch interval](https://neon.com/docs/realtime/examples/tanstack.md)
- [Build a fully reactive app on Postgres](https://neon.com/docs/realtime/examples/nextjs.md)
- [Send feedback to the Neon team (CLI, HTTP, or MCP)](https://neon.com/feedback.md)

## Introduction

Architecture, features, autoscaling, branching concepts, billing, and plans.

- [All 36 Introduction pages](https://neon.com/docs/introduction/llms.txt) […] key pages below

- [The lakebase architecture](https://neon.com/docs/introduction/architecture-overview.md): Inside Lakebase Postgres: decoupled compute and durable storage
- [Plans and billing](https://neon.com/docs/introduction/about-billing.md): Learn about Neon's pricing plans and how to manage billing
- [Autoscaling](https://neon.com/docs/introduction/autoscaling.md): An introduction to Neon's autoscaling
- [Scale to Zero](https://neon.com/docs/introduction/scale-to-zero.md): Minimize costs by automatically scaling inactive databases to zero
- [Branching](https://neon.com/docs/introduction/branching.md): Branch your data the same way you branch your code
- [Neon Read Replicas](https://neon.com/docs/introduction/read-replicas.md): Scale your app, run ad-hoc queries, and provide read-only access without duplicating data

## Get Started

First-time setup: org/project creation, connection strings, driver installation, optional auth, and initial schema setup.

- [Build a full backend with Next.js and Neon](https://neon.com/docs/get-started/full-backend-quickstart.md): Postgres, Object Storage, and a Neon Function for AI, declared in one neon.ts
- [Built to scale](https://neon.com/docs/get-started/built-to-scale.md): Neon supports you from prototype to scale-up
- [Built to scale](https://neon.com/docs/get-started/production-readiness.md): Neon supports you from prototype to scale-up
- [Connecting Neon to your stack](https://neon.com/docs/get-started/connect-neon.md): Learn how to integrate Neon into your application
- [Database branching workflow primer](https://neon.com/docs/get-started/workflow-primer.md): An introduction to integrating Postgres branching into your development workflow
- [Get started with your AI agent](https://neon.com/docs/get-started/with-an-agent.md): Set up Neon in your project using your AI coding assistant
- [Getting ready for production](https://neon.com/docs/get-started/production-checklist.md): Guidelines to optimize price, performance, and reliability
- [How a Neon backend fits together](https://neon.com/docs/get-started/backend-overview.md): Postgres, Object Storage, Functions, the AI Gateway, Auth, and the Data API, declared in one neon.ts and branched together

First 65 of 350 lines. 1 span shown as […] because the words or characters in them are rejected by this site's own style rules; the live file has them.