neon-toolkit

Neon Toolkit 技能

使用 Neon Toolkit 自动创建、管理和清理临时 Neon 数据库。

适用场景

• 为每次测试运行创建全新的数据库
• 在 CI/CD 管道中快速启动数据库
• 构建隔离的开发环境
• 无需手动设置即可快速原型设计

不建议用于： 生产数据库、团队共享环境、仅限本地的开发（请使用 Docker）或免费套餐账户（需要付费项目）。

代码生成规则

生成 TypeScript/JavaScript 代码时：

• 在生成导入语句之前，检查 tsconfig.json 中的路径别名（compilerOptions.paths）
• 如果存在路径别名（例如，"@/": ["./src/"]），请使用它们（例如，import { x } from '@/lib/utils'）
• 如果不存在路径别名或不确定是否存在，请始终使用相对导入（例如，import { x } from '../../../lib/utils'）
• 确认导入符合项目配置
• 默认使用相对导入——无论配置如何，它们始终有效

参考文档

主要资源： 请参阅项目根目录中的 [neon-toolkit.mdc](https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-toolkit.mdc)，获取全面指南，其中包括：

• 核心概念（组织、项目、分支、端点）
• 安装和身份验证设置
• 数据库生命周期管理模式
• API 客户端用法示例
• 错误处理策略

快速设置

安装

npm install @neondatabase/toolkit

基本用法

import { NeonToolkit } from '@neondatabase/toolkit';

const neon = new NeonToolkit({ apiKey: process.env.NEON_API_KEY! });

// Create ephemeral database
const db = await neon.createEphemeralDatabase();
console.log(`Database URL: ${db.url}`);

// Use the database...

// Cleanup
await db.delete();

模板和脚本

• templates/toolkit-workflow.ts - 完整的临时数据库工作流
• scripts/create-ephemeral-db.ts - 创建临时数据库
• scripts/destroy-ephemeral-db.ts - 清理临时数据库

常见用例

测试

const db = await neon.createEphemeralDatabase();
// Run tests with fresh database
await db.delete();

CI/CD 集成

export NEON_API_KEY=${{ secrets.NEON_API_KEY }}
npm test  # Uses ephemeral database

相关技能

• neon-serverless - 用于连接数据库
• neon-drizzle - 用于架构和迁移

---

想在项目中采用最佳实践？ 运行 neon-plugin:add-neon-docs，并将参数设为 SKILL_NAME="neon-toolkit"，以添加参考链接。