关于 using-neon
using-neon 是使用 Neon 无服务器 Postgres 平台时查阅文档的技能。它按主题整理设置、驱动、SDK、API 和 CLI 参考,并要求以官方文档核实相关信息。
主要功能
- 01查找相关 Neon 文档
- 02依据官方文档核实信息
- 03浏览设置与连接指南
- 04定位驱动、ORM 和 SDK 参考
- 05查询 API 与 CLI 指南
适用场景
- 01了解 Neon 平台概念与功能
- 02设置项目或数据库连接
- 03选择驱动或 ORM
- 04通过 API 或 CLI 管理 Neon 资源
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ davila7/ claude-code-templates --skill using-neon安装后在 Claude Code 中输入/using-neon确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/connection-methods.mddevtools.mdfeatures.mdgetting-started.mdneon-auth.mdneon-cli.mdneon-drizzle.mdneon-js.mdneon-platform-api.mdneon-python-sdk.mdneon-serverless.mdneon-typescript-sdk.mdreferencing-docs.mdwhat-is-neon.mdreferences/neon-auth/auth-methods.mdcommon-mistakes.mdsetup-nextjs.mdsetup-react-spa.mdui-components.mdreferences/neon-js/common-mistakes.mddata-api.mdreferences/neon-rest-api/branches.mdendpoints.mdguidelines.mdkeys.mdoperations.mdorganizations.mdprojects.md详细介绍
Neon Serverless Postgres
Neon 是一个无服务器 Postgres 平台,通过分离计算和存储,提供自动扩缩容、分支、即时恢复和缩容至零等功能。它与 Postgres 完全兼容,并可与任何支持 Postgres 的语言、框架或 ORM 配合使用。
Neon 文档
在对 Neon 相关内容做出说明前,请务必查阅 Neon 文档。文档是所有 Neon 相关信息的权威来源。
下面列出了按关注领域整理的资源,旨在帮助你找到需要获取的文档页面,并提供一些额外背景信息。
你可以使用 curl 命令以 Markdown 格式获取文档页面:
文档:
# 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>
不要猜测文档页面。请使用 llms.txt 索引查找相关 URL,或访问下方资源中的链接。
资源概览
根据用户的需求,参考相应的资源文件:
核心指南
| 领域 | 资源 | 使用时机 |
|---|---|---|
| 什么是 Neon | references/what-is-neon.md | 了解 Neon 概念、架构和核心资源 |
| 查阅文档 | references/referencing-docs.md | 查找官方文档、核实信息 |
| 功能 | references/features.md | 分支、自动扩缩容、缩容至零、即时恢复 |
| 入门指南 | references/getting-started.md | 设置项目、连接字符串、依赖项和架构 |
| 连接方式 | references/connection-methods.md | 根据平台和运行时选择驱动程序 |
| 开发者工具 | references/devtools.md | VSCode 扩展、MCP 服务、Neon CLI(neon init) |
数据库驱动程序和 ORM
用于无服务器或边缘函数的 HTTP/WebSocket 查询。
| 领域 | 资源 | 使用时机 |
|---|---|---|
| 无服务器驱动程序 | references/neon-serverless.md | @neondatabase/serverless - HTTP/WebSocket 查询 |
| Drizzle ORM | references/neon-drizzle.md | Drizzle ORM 与 Neon 集成 |
身份验证和 Data API SDK
用于 Neon 的身份验证和 PostgREST 风格的 Data API。
| 领域 | 资源 | 使用时机 |
|---|---|---|
| Neon Auth | references/neon-auth.md | @neondatabase/auth - 仅用于身份验证 |
| Neon JS SDK | references/neon-js.md | @neondatabase/neon-js - 身份验证 + Data API(PostgREST 风格查询) |
Neon 平台 API 和 CLI
通过 REST API、SDK 或 CLI 以编程方式管理 Neon 资源。
| 领域 | 资源 | 使用时机 |
|---|---|---|
| 平台 API 概览 | references/neon-platform-api.md | 通过 REST API 管理 Neon 资源 |
| Neon CLI | references/neon-cli.md | 终端工作流、脚本、CI/CD 流水线 |
| TypeScript SDK | references/neon-typescript-sdk.md | @neondatabase/api-client |
| Python SDK | references/neon-python-sdk.md | neon-api 软件包 |
评论
支持 Markdown