nexusql 0.1.0

package/README.md

@@ -0,0 +1,147 @@
+# nexusql
+
+Database migration toolkit for PostgreSQL with DBML schema support.
+
+Generate migration SQL by comparing your DBML schema against your live database using [migra](https://github.com/djrobstep/migra).
+
+## Installation
+
+```bash
+npm install -g nexusql
+# or
+npx nexusql
+```
+
+### Prerequisites
+
+You need to have [migra](https://github.com/djrobstep/migra) installed:
+
+```bash
+pip install migra
+```
+
+## Quick Start
+
+1. Initialize your project:
+
+```bash
+nexusql init
+```
+
+2. Set your database URL in `.env`:
+
+```bash
+DATABASE_URL=postgres://user:password@localhost:5432/mydb
+```
+
+3. Create your schema in `schema.dbml`:
+
+```dbml
+Table users {
+  id uuid [pk, default: `uuid_generate_v4()`]
+  email varchar(255) [unique, not null]
+  name varchar(255)
+  created_at timestamp [default: `now()`]
+}
+```
+
+4. Generate and apply migrations:
+
+```bash
+nexusql migrate
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `nexusql init` | Initialize configuration and directories |
+| `nexusql gen` | Generate migration SQL from DBML schema |
+| `nexusql migrate` | Interactive: generate → create file → apply |
+| `nexusql up` | Apply all pending migrations |
+| `nexusql status` | Show migration status |
+| `nexusql mark-applied <version>` | Mark migration as applied without running |
+
+### `nexusql gen`
+
+Generate migration SQL by diffing your current database against the DBML schema.
+
+```bash
+nexusql gen                    # Output to stdout
+nexusql gen -o migration.sql   # Write to file
+nexusql gen -v                 # Verbose output
+```
+
+### `nexusql migrate`
+
+Interactive workflow that combines generation and file creation:
+
+```bash
+nexusql migrate                # Interactive mode
+nexusql migrate -n "add_users" # Specify migration name
+nexusql migrate -a             # Apply immediately
+nexusql migrate -y             # Skip confirmations
+```
+
+### `nexusql up`
+
+Apply all pending migrations:
+
+```bash
+nexusql up
+```
+
+### `nexusql status`
+
+Show which migrations have been applied and which are pending:
+
+```bash
+nexusql status
+```
+
+## Configuration
+
+Create `nexusql.config.js` in your project root:
+
+```js
+export default {
+  // Path to DBML schema file
+  schema: './schema.dbml',
+
+  // Migration files directory
+  migrations: './db/migrations',
+
+  // PostgreSQL extensions to install in temp database
+  extensions: ['uuid-ossp', 'vector'],
+};
+```
+
+Environment variables:
+- `DATABASE_URL` - PostgreSQL connection string
+
+## Migration Format
+
+Migrations use dbmate-compatible format:
+
+```sql
+-- migrate:up
+CREATE TABLE users (
+  id uuid PRIMARY KEY DEFAULT uuid_generate_v4(),
+  email varchar(255) UNIQUE NOT NULL
+);
+
+-- migrate:down
+DROP TABLE users;
+```
+
+## How It Works
+
+1. Reads your DBML schema and converts it to SQL
+2. Creates a temporary database and loads the target schema
+3. Uses `migra` to generate the diff between current and target
+4. Creates a timestamped migration file
+5. Tracks applied migrations in `schema_migrations` table
+
+## License
+
+MIT

package/bin/nexusql.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.js';

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node