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.
- License 许可
- MIT
- 最近更新
- 2026-08-16
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- using-neon
- description
- 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.
02 资源文件 28
- 参考文档references/connection-methods.md7.2 KB
- 参考文档references/devtools.md3.4 KB
- 参考文档references/features.md5.0 KB
- 参考文档references/getting-started.md5.8 KB
- 参考文档references/neon-auth.md3.8 KB
- 参考文档references/neon-auth/auth-methods.md6.3 KB
- 参考文档references/neon-auth/common-mistakes.md5.6 KB
- 参考文档references/neon-auth/setup-nextjs.md2.7 KB
- 参考文档references/neon-auth/setup-react-spa.md5.8 KB
- 参考文档references/neon-auth/ui-components.md4.8 KB
- 参考文档references/neon-cli.md3.9 KB
- 参考文档references/neon-drizzle.md6.3 KB
- 参考文档references/neon-js.md5.6 KB
- 参考文档references/neon-js/common-mistakes.md2.7 KB
- 参考文档references/neon-js/data-api.md8.5 KB
- 参考文档references/neon-platform-api.md4.1 KB
- 参考文档references/neon-python-sdk.md4.2 KB
- 参考文档references/neon-rest-api/branches.md20.0 KB
- 参考文档references/neon-rest-api/endpoints.md8.3 KB
- 参考文档references/neon-rest-api/guidelines.md6.5 KB
- 参考文档references/neon-rest-api/keys.md2.1 KB
- 参考文档references/neon-rest-api/operations.md5.2 KB
- 参考文档references/neon-rest-api/organizations.md6.9 KB
- 参考文档references/neon-rest-api/projects.md22.3 KB
- 参考文档references/neon-serverless.md6.3 KB
- 参考文档references/neon-typescript-sdk.md6.2 KB
- 参考文档references/referencing-docs.md2.9 KB
- 参考文档references/what-is-neon.md3.1 KB
03 SKILL.md 正文
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.
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:
# 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.
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 |
04 同仓库更多 Skills
zapier-make-patterns
No-code automation democratizes workflow building. Zapier and Make (formerly Integromat) let non-developers automate business processes without writing code. But no-code doesn't mean no-complexity - these platforms have their own patterns, pitfalls, and breaking points. This skill covers when to use which platform, how to build reliable automations, and when to graduate to code-based solutions. Key insight: Zapier optimizes for simplicity and integrations (7000+ apps), Make optimizes for power
yeet
Use only when the user explicitly asks to stage, commit, push, and open a GitHub pull request in one flow using the GitHub CLI (`gh`).
workflow-automation
Workflow automation is the infrastructure that makes AI agents reliable. Without durable execution, a network hiccup during a 10-step payment flow means lost money and angry customers. With it, workflows resume exactly where they left off. This skill covers the platforms (n8n, Temporal, Inngest) and patterns (sequential, parallel, orchestrator-worker) that turn brittle scripts into production-grade automation. Key insight: The platforms make different tradeoffs. n8n optimizes for accessibility
trigger-dev
Trigger.dev expert for background jobs, AI workflows, and reliable async execution with excellent developer experience and TypeScript-first design. Use when: trigger.dev, trigger dev, background task, ai background job, long running task.
slack-automation
Automate Slack workspace operations including messaging, search, channel management, and reaction workflows through Composio's Slack toolkit.
planning-with-files
Transforms workflow to use Manus-style persistent markdown files for planning, progress tracking, and knowledge storage. Use when starting complex tasks, multi-step projects, research tasks, or when the user mentions planning, organizing work, tracking progress, or wants structured output.