Guides and best practices for working with Neon Serverless Postgres. Covers getting started, local development with Neon, choosing a connection method, Neon features, authentication (@neondatabase/auth), PostgREST-style data API (@neondatabase/neon-js), Neon CLI, and Neon's Platform API/SDKs. Use for any Neon-related questions.
Neon is a serverless Postgres platform that separates compute and storage to offer autoscaling, branching, instant restore, and scale-to-zero. It's fully compatible with Postgres and works with any language, framework, or ORM that supports Postgres.
Always reference the Neon documentation before making Neon-related claims. The documentation is the source of truth for all Neon-related information.
Below you'll find a list of resources organized by area of concern. This is meant to support you find the right documentation pages to fetch and add a bit of additonal context.
You can use the curl commands to fetch the documentation page as markdown:
Documentation:
# Get list of all Neon docs
curl https://neon.tech/llms.txt
# Fetch any doc page as markdown
curl -H "Accept: text/markdown" https://neon.tech/docs/<path>
Don't guess docs pages. Use the llms.txt index to find the relevant URL or follow the links in the resources below.
Reference the appropriate resource file based on the user's needs:
| Area | Resource | When to Use |
| ------------------ | ---------------------------------- | -------------------------------------------------------------- |
| What is Neon | references/what-is-neon.md | Understanding Neon concepts, architecture, core resources |
| Referencing Docs | references/referencing-docs.md | Looking up official documentation, verifying information |
| Features | references/features.md | Branching, autoscaling, scale-to-zero, instant restore |
| Getting Started | references/getting-started.md | Setting up a project, connection strings, dependencies, schema |
| Connection Methods | references/connection-methods.md | Choosing drivers based on platform and runtime |
| Developer Tools | references/devtools.md | VSCode extension, MCP server, Neon CLI (neon init) |
HTTP/WebSocket queries for serverless/edge functions.
| Area | Resource | When to Use |
| ----------------- | ------------------------------- | --------------------------------------------------- |
| Serverless Driver | references/neon-serverless.md | @neondatabase/serverless - HTTP/WebSocket queries |
| Drizzle ORM | references/neon-drizzle.md | Drizzle ORM integration with Neon |
Authentication and PostgREST-style data API for Neon.
| Area | Resource | When to Use |
| ----------- | ------------------------- | ------------------------------------------------------------------- |
| Neon Auth | references/neon-auth.md | @neondatabase/auth - Authentication only |
| Neon JS SDK | references/neon-js.md | @neondatabase/neon-js - Auth + Data API (PostgREST-style queries) |
Managing Neon resources programmatically via REST API, SDKs, or CLI.
| Area | Resource | When to Use |
| --------------------- | ----------------------------------- | -------------------------------------------- |
| Platform API Overview | references/neon-platform-api.md | Managing Neon resources via REST API |
| Neon CLI | references/neon-cli.md | Terminal workflows, scripts, CI/CD pipelines |
| TypeScript SDK | references/neon-typescript-sdk.md | @neondatabase/api-client |
| Python SDK | references/neon-python-sdk.md | neon-api package |
Copy a source-pinned command for your client. You run it yourself.
Destination: .claude/skills/using-neon · pinned to the source commit
# Run from your project root
git clone https://github.com/davila7/claude-code-templates.git .skillboard-tmp
git -C .skillboard-tmp checkout 5cc17cf267132cc690dee82239b80a99ec82e4f8
mkdir -p ".claude/skills"
cp -r ".skillboard-tmp/cli-tool/components/skills/database/using-neon" ".claude/skills/"
rm -rf .skillboard-tmpReview the source before running. This copies files into your project; it is not a one-click install and does not verify runtime safety.
sudo apt update && sudo apt install -y gitnpm install -g @anthropic-ai/claude-code# Run from your project root
git clone https://github.com/davila7/claude-code-templates.git .skillboard-tmp
git -C .skillboard-tmp checkout 5cc17cf267132cc690dee82239b80a99ec82e4f8
mkdir -p ".claude/skills"
cp -r ".skillboard-tmp/cli-tool/components/skills/database/using-neon" ".claude/skills/"
rm -rf .skillboard-tmpDestination: .claude/skills/using-neon
Scanner static-checks@0.1.0 · commit 5cc17cf26713. Static checks cannot prove runtime safety – review the source and the exact diff before installing. How checks work.
Fetches remote content at runtime, which can change after review.
Evidence: curl· fingerprint 427e4b79b1f0fc90