create-db 0.0.11-pr27-feat-posthog-16472140508.0 → 0.0.11-pr30-readme-16472332987.0

package/README.md

@@ -1,50 +1,108 @@
-# Create DB CLI
+## **What is `create-db`?**
 
-CLI tool for provisioning a [temporary Prisma Postgres databases](https://www.prisma.io/postgres?utm_source=create_db_npm_docs).
+`create-db` is an open-source CLI tool that provisions [**temporary Prisma Postgres databases**](https://www.prisma.io/postgres?utm_source=create_db_npm_docs) with a single command.
 
-## Usage
+![Demo Gif](demo.gif)
+
+Each database is available for **24 hours** by default. To keep the database permanently, you can **claim it for free** using the URL displayed in the CLI output.
+
+This tool is designed for developers who need a fast way to test, prototype, or integrate Prisma Postgres without manual setup or creating an account.
+
+## **Installation and usage**
+
+There is no need to install the tool globally. Simply run:
 
 ```bash
-npx create-db                    # Default region (us-east-1)
-npx create-db --region eu-west-1 # Custom region
-npx create-db --i               # Interactive region selection
+npx create-db@latest
 ```
 
-## Key Files
+You can also use the following aliases:
 
-- **Main Logic:** [`index.js`](index.js) - Argument parsing, API requests, and output
-- **Configuration:** [`package.json`](package.json) - CLI entry point and dependencies
-- **Environment:** `.env` - Worker endpoints configuration
+```bash
+npx create-pg@latest
+npx create-postgres@latest
+```
 
-## Development
+## **Examples**
 
 ```bash
-npm install
+npx create-db                    # Creates a database in the default region
+npx create-db --region eu-west-1 # Creates a database in a specific region
+npx create-db --i                # Interactive region selection
+
 ```
 
-Create `.env` for local development:
+## **Available options**
 
-```env
-# LOCAL
-CREATE_DB_WORKER_URL="http://127.0.0.1:8787"
-CLAIM_DB_WORKER_URL="http://127.0.0.1:8787"
+You can run `npx create-db --help` or `npx create-db -h` to see all the available CLI options:
 
-# PROD
-# CLAIM_DB_WORKER_URL="https://create-db.prisma.io"
-# CREATE_DB_WORKER_URL="https://create-db-temp.prisma.io"
 ```
+npx create-db [options]
+
+Options:
+  --region <region>, -r <region>  Specify a region
+                                  Available regions:
+                                  ap-southeast-1, ap-northeast-1,
+                                  eu-central-1, eu-west-3,
+                                  us-east-1, us-west-1
+
+  --interactive, -i               Run in interactive mode
 
-If running both workers locally, use a different port for one and update the URL:
+  --help, -h                      Show this help message
 
-```env
-CREATE_DB_WORKER_URL="http://127.0.0.1:9999"
-CLAIM_DB_WORKER_URL="http://127.0.0.1:8787"
 ```
 
-## Test Locally
+## **CLI output example**
+
+```
+┌  🚀 Creating a Prisma Postgres database
+│
+│  Provisioning a temporary database in us-east-1...
+│
+│  It will be automatically deleted in 24 hours, but you can claim it.
+│
+◇  Database created successfully!
+│
+●  Connect to your database →
+│
+│    Prisma connection string:
+│    prisma+postgres://accelerate.prisma-data.net/?api_key=...
+│
+│    Standard connection string:
+│    postgresql://<username>:<password>@db.prisma.io:5432/postgres
+│
+◆  Claim your database →
+│
+│    Want to keep your database? Claim for free:
+│    https://create-db.prisma.io?projectID=proj_...
+└
 
-```bash
-npx create-db
-npx create-db --region eu-west-1
-npx create-db --i
 ```
+
+## **Claiming a database**
+
+When you create a database using `create-db`, it is temporary and will be deleted automatically after **24 hours**.
+
+The CLI output includes a **claim URL** that allows you to keep the database permanently for free.
+
+**What claiming does:**
+
+- Moves the database into your Prisma Postgres account.
+- Prevents it from being auto-deleted.
+- Lets you continue using the database as a long-term instance.
+
+Example:
+
+```
+◆  Claim your database →
+│
+│    Want to keep your database? Claim for free:
+|
+│    https://create-db.prisma.io?projectID=proj_...
+│
+│    Your database will be deleted on 7/24/2025, 2:25:41 AM if not claimed.
+```
+
+## **Next steps**
+
+- Refer to the section in the official [Prisma Postgres documentation](https://www.prisma.io/docs/postgres/introduction/npx-create-db).

package/index.js

@@ -1,8 +1,5 @@
 #!/usr/bin/env node
 
-import dotenv from "dotenv";
-dotenv.config();
-
 import {
   select,
   spinner,
@@ -10,10 +7,13 @@ import {
   outro,
   log,
   cancel,
+  confirm,
 } from "@clack/prompts";
 import chalk from "chalk";
+import dotenv from "dotenv";
 import terminalLink from "terminal-link";
-import { analytics } from "./analytics.js";
+
+dotenv.config();
 
 const CREATE_DB_WORKER_URL =
   process.env.CREATE_DB_WORKER_URL || "https://create-db-temp.prisma.io";
@@ -265,17 +265,6 @@ async function promptForRegion(defaultRegion) {
     process.exit(0);
   }
 
-  // Track region selection event
-  try {
-    await analytics.capture("create_db:region_selected", {
-      command: CLI_NAME,
-      region: region,
-      "selection-method": "interactive"
-    });
-  } catch (error) {
-    // Silently fail analytics
-  }
-
   return region;
 }
 
@@ -295,19 +284,6 @@ async function createDatabase(name, region) {
     s.stop(
       "We're experiencing a high volume of requests. Please try again later."
     );
-    
-    // Track database creation failure
-    try {
-      await analytics.capture("create_db:database_creation_failed", {
-        command: CLI_NAME,
-        region: region,
-        "error-type": "rate_limit",
-        "status-code": 429,
-      });
-    } catch (error) {
-      // Silently fail analytics
-    }
-    
     process.exit(1);
   }
 
@@ -317,18 +293,6 @@ async function createDatabase(name, region) {
     s.stop(
       `Error creating database: ${result.error.message || "Unknown error"}`
     );
-    
-    // Track database creation failure
-    try {
-      await analytics.capture("create_db:database_creation_failed", {
-        command: CLI_NAME,
-        region: region,
-        "error-type": "api_error",
-        "error-message": result.error.message,
-      });
-    } catch (error) {
-      // Silently fail analytics
-    }
     process.exit(1);
   }
 
@@ -398,26 +362,6 @@ async function createDatabase(name, region) {
 
 async function main() {
   try {
-    const rawArgs = process.argv.slice(2);
-    log.message(
-      chalk.white(`POSTHOG: ${process.env.POSTHOG_API_KEY} ${process.env.POSTHOG_API_HOST}`)
-    );
-    try {
-      await analytics.capture("create_db:cli_command_ran", {
-        command: CLI_NAME,
-        "full-command": `${CLI_NAME} ${rawArgs.join(' ')}`.trim(),
-        "has-region-flag": rawArgs.includes('--region') || rawArgs.includes('-r'),
-        "has-interactive-flag": rawArgs.includes('--interactive') || rawArgs.includes('-i'),
-        "has-help-flag": rawArgs.includes('--help') || rawArgs.includes('-h'),
-        "has-list-regions-flag": rawArgs.includes('--list-regions'),
-        "node-version": process.version,
-        platform: process.platform,
-        arch: process.arch
-      });
-    } catch (error) {
-      // Silently fail analytics
-    }
-
     // Parse command line arguments
     const { flags } = await parseArgs();
 
@@ -442,17 +386,6 @@ async function main() {
     // Apply command line flags
     if (flags.region) {
       region = flags.region;
-      
-      // Track region selection via flag
-      try {
-        await analytics.capture("create_db:region_selected", {
-          command: CLI_NAME,
-          region: region,
-          "selection-method": "flag"
-        });
-      } catch (error) {
-        // Silently fail analytics
-      }
     }
     if (flags.interactive) {
       chooseRegionPrompt = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-db",
-  "version": "0.0.11-pr27-feat-posthog-16472140508.0",
+  "version": "0.0.11-pr30-readme-16472332987.0",
   "description": "Instantly create a temporary Prisma Postgres database with one command, then claim and persist it in your Prisma Data Platform project when ready.",
   "main": "index.js",
   "author": "",
@@ -39,6 +39,6 @@
   "files": [
     "index.js",
     "README.md",
-    "analytics.js"
+    "demo.gif"
   ]
 }

package/analytics.js

@@ -1,60 +0,0 @@
-import { randomUUID } from "crypto";
-
-class EventCaptureError extends Error {
-  constructor(event, status) {
-    super(`Failed to submit PostHog event '${event}': ${status}`);
-  }
-}
-
-class PosthogEventCapture {
-  async capture(eventName, properties = {}) {
-    const POSTHOG_CAPTURE_URL = process.env.POSTHOG_API_HOST
-      ? process.env.POSTHOG_API_HOST + "/capture"
-      : null;
-    const POSTHOG_KEY = process.env.POSTHOG_API_KEY;
-
-    // Skip if environment variables are not set
-    if (!POSTHOG_CAPTURE_URL || !POSTHOG_KEY) {
-      if (process.env.NODE_ENV === "development") {
-        console.warn(
-          "Analytics skipped: POSTHOG_API_HOST or POSTHOG_API_KEY not set"
-        );
-      }
-      return;
-    }
-
-    const payload = {
-      api_key: POSTHOG_KEY,
-      event: eventName,
-      distinct_id: randomUUID(),
-      properties: {
-        $process_person_profile: false,
-        ...properties,
-      },
-    };
-
-    try {
-      const response = await fetch(POSTHOG_CAPTURE_URL, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(payload),
-      });
-
-      if (!response.ok) {
-        throw new EventCaptureError(eventName, response.statusText);
-      }
-    } catch (error) {
-      // Silently fail analytics to not disrupt user experience
-      if (process.env.NODE_ENV === "development") {
-        console.error("Analytics error:", error.message);
-      }
-    }
-  }
-}
-
-// Create a singleton instance
-const analytics = new PosthogEventCapture();
-
-export { analytics, EventCaptureError };