using-neon
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.
Best use case
using-neon is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
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.
Teams using using-neon should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/using-neon/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How using-neon Compares
| Feature / Agent | using-neon | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
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.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Neon Serverless Postgres 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. ## When to Use This Skill Use this skill when: - Working with Neon Serverless Postgres - Setting up Neon databases - Choosing connection methods for Neon - Using Neon features like branching or autoscaling - Working with Neon authentication or APIs - Questions about Neon best practices ## Neon Documentation 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:** ```bash # Get list of all Neon docs curl https://neon.com/llms.txt # Fetch any doc page as markdown curl -H "Accept: text/markdown" https://neon.com/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. ## Overview of Resources Reference the appropriate resource file based on the user's needs: ### Core Guides | 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`) | ### Database Drivers & ORMs 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 | ### Auth & Data API SDKs 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) | ### Neon Platform API & CLI 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 |
Related Skills
using-dbt-for-analytics-engineering
Builds and modifies dbt models, writes SQL transformations using ref() and source(), creates tests, and validates results with dbt show. Use when doing any dbt work - building or modifying models, debugging errors, exploring unfamiliar data sources, writing tests, or evaluating impact of changes.
when-using-flow-nexus-platform-use-flow-nexus-platform
Comprehensive Flow Nexus platform management covering authentication, sandboxes, storage, databases, app deployment, payments, and monitoring. This SOP provides end-to-end platform operations.
when-using-advanced-swarm-use-swarm-advanced
Advanced swarm patterns with dynamic topology switching and self-organizing behaviors for complex multi-agent coordination
using-superpowers
Meta-skill enforcing skill discovery and invocation discipline through mandatory workflows. Use when starting any conversation to check for relevant skills before any response, ensuring skill-first workflow before proceeding.
using-git-worktrees
Git worktree–based workspace isolation for parallel or non-disruptive development. Use when work must occur without modifying or interfering with the current working tree.
using-argc-argcfile
Create and modify Argcfiles using the special syntax required. Use this when editing Argcfile.sh, @argc, or any shell script that contains `argc --argc-eval`.
neon-postgres
Neon PostgreSQL serverless database - connection pooling, branching, serverless driver, and optimization. Use when deploying to Neon or building serverless applications.
using-beads-bv
Use when coordinating dependency-aware task planning with beads (bd) CLI and bv graph sidecar - covers ready work selection, priority management, and robot flags for deterministic outputs
using-agent-relay
Use when coordinating multiple AI agents in real-time - provides inter-agent messaging via tmux wrapper (sub-5ms latency) or file-based team inbox for async workflows
using-xtool
This skill should be used when building iOS apps with xtool (Xcode-free iOS development), creating xtool projects, adding app extensions, or configuring xtool.yml. Triggers on "xtool", "SwiftPM iOS", "iOS on Linux", "iOS on Windows", "Xcode-free", "app extension", "widget extension", "share extension". Covers project setup, app extensions, and deployment.
Neon
## Overview
Neon — Serverless Postgres
You are an expert in Neon, the serverless Postgres platform. You help developers use fully managed PostgreSQL with instant database branching, autoscaling to zero, edge-compatible HTTP driver, connection pooling, and point-in-time recovery — enabling development workflows where each PR gets its own database branch and production scales automatically based on load.