neon-toolkit

Создаёт и управляет эфемерными базами данных Neon для тестирования, CI/CD-пайплайнов и изолированных сред разработки. Используйте при создании временных баз данных для…

npx skills add https://github.com/neondatabase/ai-rules --skill neon-toolkit

Neon Toolkit Skill

Automates creation, management, and cleanup of temporary Neon databases using the Neon Toolkit.

When to Use

  • Creating fresh databases for each test run
  • Spinning up databases in CI/CD pipelines
  • Building isolated development environments
  • Rapid prototyping without manual setup

Not recommended for: Production databases, shared team environments, local-only development (use Docker), or free tier accounts (requires paid projects).

Code Generation Rules

When generating TypeScript/JavaScript code:

  • BEFORE generating import statements, check tsconfig.json for path aliases (compilerOptions.paths)
  • If path aliases exist (e.g., "@/": ["./src/"]), use them (e.g., import { x } from '@/lib/utils')
  • If NO path aliases exist or unsure, ALWAYS use relative imports (e.g., import { x } from '../../../lib/utils')
  • Verify imports match the project's configuration
  • Default to relative imports - they always work regardless of configuration

Reference Documentation

Primary Resource: See [neon-toolkit.mdc](https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-toolkit.mdc) in project root for comprehensive guidelines including:

  • Core concepts (Organization, Project, Branch, Endpoint)
  • Installation and authentication setup
  • Database lifecycle management patterns
  • API client usage examples
  • Error handling strategies

Quick Setup

Installation

npm install @neondatabase/toolkit

Basic Usage

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 & Scripts

  • templates/toolkit-workflow.ts - Complete ephemeral database workflow
  • scripts/create-ephemeral-db.ts - Create a temporary database
  • scripts/destroy-ephemeral-db.ts - Clean up ephemeral database

Common Use Cases

Testing

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

CI/CD Integration

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

Related Skills

  • neon-serverless - For connecting to databases
  • neon-drizzle - For schema and migrations

Want best practices in your project? Run neon-plugin:add-neon-docs with parameter SKILL_NAME="neon-toolkit" to add reference links.

Больше skills от neondatabase

add-neon-docs
neondatabase
Используйте этот навык, когда пользователь просит добавить документацию, добавить доки, добавить ссылки или установить документацию о Neon. Добавляет ссылки на рекомендации Neon…
better-env
neondatabase
Улучшенное управление переменными окружения для агентов и людей с полной типовой безопасностью, синхронизацией удаленного окружения через CLI и валидацией окружения.
claimable-postgres
neondatabase
Мгновенные базы данных Postgres для локальной разработки, демонстраций, прототипирования и тестовых сред. Без необходимости регистрации. Базы данных истекают через 72 часа, если не привязаны к аккаунту Neon.
claimable-postgres
neondatabase
Создайте мгновенную базу данных Postgres с помощью Claimable Postgres от Neon (pg.new) для быстрой локальной разработки, демонстраций, прототипирования и тестовых сред.
logging-best-practices
neondatabase
Лучшие практики логирования, ориентированные на широкие события (канонические строки журнала) для мощной отладки и аналитики
neon
neondatabase
Обзор платформы Neon для приложений и агентов, охватывающий Postgres, Auth, Data API, а также новые сервисы: Object Storage, Compute Functions и AI Gateway. Используйте всякий раз, когда упоминается «Neon», для общего описания работы с Neon и начала работы. В остальных случаях триггерами выступают отдельные возможности: «object storage» или «S3-совместимое хранилище», «serverless functions», «фоновые задачи» или «выполнение кода рядом с моей базой данных», «AI gateway», «LLM-прокси», «маршрутизация моделей» или «вызов LLM» →...
apidevelopmentdatabase
neon-ai-gateway
neondatabase
Один API и один набор учетных данных для передовых и открытых LLM, встроенные в вашу ветку Neon и работающие на Databricks. Используйте, когда пользователь хочет вызвать LLM, добавить…
neon-auth
neondatabase
Настраивает Neon Auth для вашего приложения. Конфигурирует аутентификацию, создает маршруты аутентификации и генерирует компоненты пользовательского интерфейса. Используйте при добавлении аутентификации в Next.js,…