neon-init 0.0.0 → 0.4.0

package/LICENSE.md

@@ -0,0 +1,178 @@
+# Apache License 2.0
+
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,58 @@
+# neon-init
+
+Set up your project with Neon's MCP Server and AI assistant best practices.
+
+## Installation
+
+```sh
+npm add neon-init
+```
+
+## Usage
+
+```ts
+import { init } from "neon-init";
+
+await init();
+```
+
+Then:
+
+1. Restart your AI coding assistant (Cursor, Windsurf, etc.)
+2. Type **"Get started with Neon"** in your AI chat
+
+## What It Does
+
+### 1. Configures Neon MCP Server
+
+Creates `~/.cursor/mcp.json` (global config) to enable AI-powered database operations through the Model Context Protocol.
+
+**Authentication:** Uses OAuth via `neonctl` and creates an API key for you - opens your browser, no manual API keys needed.
+
+### 2. Creates AGENTS.md
+
+Adds Neon-specific guidance to `AGENTS.md` (or creates it if it doesn't exist) with:
+
+-   Interactive "Get started with Neon" onboarding flow for AI assistants
+-   Security, performance, and schema management best practices
+-   Neon-specific features (branching, autoscaling, scale-to-zero)
+
+Works with all AI tools that support AGENTS.md: Cursor, Windsurf, Claude Code, etc.
+
+### 3. Organization Selection
+
+If you have multiple Neon organizations, you'll choose which one to use. The org ID is saved in AGENTS.md so AI assistants know which organization context to use.
+
+## Development
+
+| Command      | Description       |
+| ------------ | ----------------- |
+| `pnpm build` | Build the package |
+| `pnpm test`  | Run the tests     |
+
+### From workspace root
+
+| Command                         | Description       |
+| ------------------------------- | ----------------- |
+| `pnpm --filter neon-init build` | Build the package |
+| `pnpm --filter neon-init test`  | Run the tests     |

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+//#region src/index.d.ts
+declare function init(): void;
+//#endregion
+export { init };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";iBAAgB,IAAA,CAAA"}

package/dist/index.js

@@ -0,0 +1,8 @@
+//#region src/index.ts
+function init() {
+	console.log("Hello world from `neon-init`!");
+}
+
+//#endregion
+export { init };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export function init() {\n\tconsole.log(\"Hello world from `neon-init`!\");\n}\n"],"mappings":";AAAA,SAAgB,OAAO;AACtB,SAAQ,IAAI,gCAAgC"}

package/package.json

@@ -1,13 +1,60 @@
 {
   "name": "neon-init",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "0.4.0",
+  "description": "Initialize Neon projects",
+  "keywords": [
+    "neon",
+    "database",
+    "postgres",
+    "init"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/neondatabase/neondb-cli.git"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Neon",
+    "url": "https://neon.com"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "neon-init": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "README.md",
+    "dist/",
+    "package.json",
+    "src/agents-template.md"
+  ],
+  "devDependencies": {
+    "@types/node": "22.13.10",
+    "@vitest/coverage-v8": "3.0.9",
+    "console-fail-test": "0.5.0",
+    "tsdown": "^0.14.1",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "packageManager": "pnpm@10.14.0"
-}
+  "dependencies": {
+    "@clack/prompts": "0.10.1"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "provenance": false
+  },
+  "scripts": {
+    "build": "tsc --noEmit && tsdown",
+    "test": "vitest --passWithNoTests",
+    "test:ci": "vitest run --passWithNoTests",
+    "tsc": "tsc"
+  }
+}

package/src/agents-template.md

@@ -0,0 +1,225 @@
+## Neon Database Guidelines
+
+> **Context:** These guidelines apply when working with Neon Postgres databases in this project.
+>
+> **When to use:** Code involving database connections, queries, schema management, or Neon-specific features.
+
+This file provides guidance to AI coding assistants (Cursor, Windsurf, etc.) when working with Neon in this project.
+
+---
+
+## Communication Style
+
+**Keep all responses succinct:**
+
+-   ✅ Tell the user what you did: "Created users table with 3 columns"
+-   ✅ Ask direct questions when needed: "Which database should I use?"
+-   ❌ Avoid verbose explanations of what you're about to do
+-   ❌ Don't explain every step unless the user asks
+
+**Examples:**
+
+-   **Good**: "Added DATABASE_URL to .env. Ready to connect?"
+-   **Bad**: "I'm going to add the DATABASE_URL environment variable to your .env file so that your application can connect to the database. This will allow..."
+
+---
+
+## Get Started with Neon (Interactive Guide)
+
+**TRIGGER PHRASE:** When the user says "Get started with Neon" or similar phrases, provide an interactive onboarding experience by following these steps:
+
+**Before starting:** Let the user know they can pause and resume anytime by saying "Continue with Neon setup" if they need to come back later.
+
+**RESUME TRIGGER:** If the user says "Continue with Neon setup" or similar, check what's already configured (MCP server, .env, dependencies, schema) and resume from where they left off. Ask them which step they'd like to continue from or analyze their setup to determine automatically.
+
+### Step 1: Check Existing Neon Projects
+
+Use the Neon MCP Server to check if the user has existing projects (remember to use the configured `org_id` if specified above). Then guide them based on what you find:
+
+**If they have NO projects:**
+
+-   Ask if they want to create a new project
+-   Guide them to create one at console.neon.tech or help them do it via the MCP server
+
+**If they have 1 project:**
+
+-   Show them the project name and ask: "Would you like to use '{project_name}' or create a new one?"
+-   If they choose existing project, proceed to Step 3
+-   If they want to create new, guide them accordingly
+
+**If they have multiple projects (less than 20):**
+
+-   List all their projects with each name
+-   Ask which one they want to work on, OR
+-   Offer the option to create a new project
+-   Confirm their selection before proceeding
+
+**If they have many projects (20+):**
+
+-   Tell them how many projects they have
+-   Ask them to specify which project they want to use by name or ID
+-   Or offer to help them create a new one
+
+### Step 2: Database Setup
+
+**Get the connection string:**
+
+-   Use the MCP server to get the connection string for the selected project
+
+**Configure it for their environment:**
+
+-   Most projects use a `.env` file with `DATABASE_URL`
+-   For other setups (deployed platforms, containers, cloud configs), check their project structure and ask where they store credentials
+
+**Important:** If you cannot write to the file (permissions, file location, etc.), run the command to allow the user to add it themselves:
+
+```bash
+echo "DATABASE_URL=postgresql://..." >> .env
+```
+
+Or show them the exact line to add:
+
+```
+DATABASE_URL=postgresql://user:password@host/database
+```
+
+### Step 3: Install Dependencies
+
+Check if the user already has a common driver installed. If not, based on their framework, environment and use case, recommend the appropriate driver and install it for the user. Keep the conversation focused.
+
+**For Serverless/Edge (Vercel, Cloudflare Workers, etc.):**
+
+```bash
+npm install @neondatabase/serverless
+```
+
+**For Traditional Node.js:**
+
+```bash
+npm install pg
+```
+
+### Step 4: Understand the Project
+
+**First, check if this is an empty/new project:**
+
+-   Look for existing source code, routes, components, or substantial application logic
+-   Check if it's just a bare package.json or minimal boilerplate
+
+**If it's an empty or near-empty project:**
+
+Ask the user briefly (1-2 questions):
+
+-   What are they building? (e.g., "a blog", "an API for a mobile app", "a SaaS dashboard")
+-   Any specific technologies they want to use? (e.g., "Next.js", "tRPC", "Express")
+
+**If it's an established project:**
+
+Skip the questions - you can infer what they're building from the existing codebase.
+
+**Remember the context** (whether from questions or code analysis) for all subsequent MCP Server interactions and recommendations. However, stay focused on Neon setup - don't get sidetracked into other architectural discussions until setup is complete.
+
+### Step 5: ORM Setup
+
+**Check if they have an ORM:**
+
+Look for ORM configuration files or imports (Prisma, Drizzle, TypeORM, etc.)
+
+**If no ORM found:**
+
+Ask: "Want to set up an ORM for type-safe database queries?"
+
+**If yes, suggest based on their project:**
+
+If they decline, proceed with raw SQL queries.
+
+### Step 6: Schema Setup
+
+**First, check for existing schema:**
+
+Search the codebase for:
+
+-   SQL migration files (`.sql`, `migrations/` folder)
+-   ORM schemas (Prisma `schema.prisma`, Drizzle schema files, TypeORM entities)
+-   Database initialization scripts
+
+**If they have existing schema:**
+
+-   Show them what you found
+-   Ask: "Found existing schema definitions. Want to migrate these to your Neon database?"
+-   If yes, help execute the migrations using the MCP server or guide them through their ORM's migration process
+
+**If no existing schema found:**
+
+Ask if they want to:
+
+1. Create a simple example schema (users table)
+2. Design a custom schema together
+3. Skip schema setup for now
+
+**If they choose (1):** Create a basic example users table using the MCP server:
+
+```sql
+CREATE TABLE users (
+  id SERIAL PRIMARY KEY,
+  email VARCHAR(255) UNIQUE NOT NULL,
+  name VARCHAR(255),
+  created_at TIMESTAMP DEFAULT NOW()
+);
+```
+
+**If they choose (2):** Ask them about their app's needs and help design tables. Then create the schema using the MCP server or guide them to create it via their ORM.
+
+**If they choose (3):** Move on to Step 7. They can always come back to add schema later.
+
+### Step 7: What's Next
+
+Let them know you're ready to help with more:
+
+"You're all set! Here are some things I can help with - feel free to ask about any of these (or anything else):
+
+-   Neon-specific features (branching, autoscaling, scale-to-zero)
+-   Connection pooling for production
+-   Writing queries or building API endpoints
+-   Database migrations and schema changes
+-   Performance optimization"
+
+### Important Notes:
+
+-   Be succinct yet conversational and guide them step-by-step
+-   Know the context of the user's codebase before each step
+-   Provide working, tested code examples
+-   Check for errors in their existing setup before proceeding
+-   Don't give up - always at least give the user a way to complete the setup manually.
+
+---
+
+## Neon Database Best Practices
+
+### Security
+
+**Follow these security practices:**
+
+1. Never commit connection strings to version control
+2. Use environment variables for all database credentials
+3. Prefer SSL connections (default in Neon)
+4. Use least-privilege database roles for applications
+5. Rotate API keys and passwords regularly
+
+### Neon-Specific Features
+
+**Leverage Neon's unique features:**
+
+1. **Branching**: Create database branches for development/staging
+2. **Autoscaling**: Neon automatically scales compute based on load
+3. **Scale to Zero**: Databases automatically suspend after inactivity
+4. **Point-in-Time Recovery**: Restore databases to any point in time
+
+## Additional Resources
+
+-   [Neon Documentation](https://neon.com/docs)
+-   [Neon Serverless Driver](https://neon.com/docs/serverless/serverless-driver)
+-   [Neon API Reference](https://neon.com/docs/reference/api-reference)
+-   [Postgres Documentation](https://www.postgresql.org/docs)
+
+---