@aurios/mizzling 1.1.2 → 1.1.3

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @aurios/mizzling@1.1.2 build /home/runner/work/mizzle/mizzle/packages/mizzling
+> @aurios/mizzling@1.1.3 build /home/runner/work/mizzle/mizzle/packages/mizzling
 > tsup
 
 CLI Building entry: src/cli.ts, src/index.ts
@@ -12,4 +12,4 @@
 ESM dist/cli.js            13.77 KB
 ESM dist/index.js          87.00 B
 ESM dist/chunk-DKDRM5WU.js 1.79 KB
-ESM ⚡️ Build success in 37ms
+ESM ⚡️ Build success in 36ms

package/README.md

@@ -0,0 +1,98 @@
+🌧️ Mizzling CLI
+
+Mizzling is the official command-line interface for the Mizzle ORM, designed to manage DynamoDB migrations and schemas with ease. It provides a streamlined workflow for initializing projects, detecting schema changes, and applying them to your AWS environment.
+🚀 Installation
+
+You can install the CLI as a development dependency in your project using your preferred package manager:
+Bash
+
+# Using npm
+
+npm install -D @aurios/mizzling
+
+# Using pnpm
+
+pnpm add -D @aurios/mizzling
+
+The CLI is accessible via the mizzling command.
+🛠️ Commands
+
+The CLI offers several commands to manage your DynamoDB infrastructure:
+
+1. mizzling init
+
+Initializes a new Mizzle configuration in your current directory. This is an interactive command that guides you through:
+
+    Setting the path to your schema files.
+
+    Defining the output directory for migrations and snapshots.
+
+    Configuring the AWS region and optional custom endpoints (e.g., for local development with DynamoDB Local or LocalStack).
+
+It generates a mizzle.config.ts file upon completion. 2. mizzling generate
+
+Analyzes your current schema and compares it against the last saved snapshot to generate a new migration script.
+
+    Usage: mizzling generate [--name <name>].
+
+    It automatically detects created, deleted, or updated tables.
+
+    Creates a TypeScript migration file with up and down functions for version control.
+
+3. mizzling push
+
+Directly applies schema changes to your target DynamoDB environment without generating migration files.
+
+    Usage: mizzling push [-y, --yes].
+
+    The --yes flag skips the interactive confirmation prompt.
+
+    Useful for rapid prototyping and synchronizing development environments.
+
+4. mizzling list
+
+Provides a summary of all existing DynamoDB tables in the configured environment. For each table, it displays:
+
+    The table name.
+
+    Primary Key (PK) and Sort Key (SK) attributes.
+
+    A list of Global Secondary Indexes (GSIs).
+
+5. mizzling drop
+
+An interactive tool to safely remove tables from your environment.
+
+    It fetches a list of remote tables and allows you to select multiple items for deletion.
+
+    Warning: This action is irreversible and requires explicit confirmation before proceeding.
+
+⚙️ Configuration (mizzle.config.ts)
+
+Mizzling uses a central configuration file. You can use the defineConfig helper for full TypeScript type safety:
+TypeScript
+
+import { defineConfig } from "@aurios/mizzling";
+
+export default defineConfig({
+schema: "./src/schema.ts",
+out: "./migrations",
+region: "us-east-1",
+// endpoint: "http://localhost:8000", // Optional for local dev
+});
+
+Environment Overrides
+
+Configuration values can be overridden using environment variables:
+
+    MIZZLE_REGION: Overrides the AWS region.
+
+    MIZZLE_ENDPOINT: Overrides the DynamoDB endpoint.
+
+    MIZZLE_SCHEMA: Overrides the schema path.
+
+    MIZZLE_OUT: Overrides the migrations output directory.
+
+📄 License
+
+This project is licensed under the MIT License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurios/mizzling",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "A CLI tool for managing Mizzle projects",
   "publishConfig": {
     "access": "public",
@@ -46,9 +46,9 @@
   },
   "devDependencies": {
     "tsup": "^8.5.1",
-    "@aurios/mizzle": "1.1.3",
     "@repo/shared": "0.0.3",
     "@repo/typescript-config": "0.0.0",
+    "@aurios/mizzle": "1.1.3",
     "@repo/vitest-config": "0.0.0"
   },
   "scripts": {