@aurios/mizzling 1.1.3 → 1.1.4

package/.turbo/turbo-build.log

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

package/README.md

@@ -1,98 +1,81 @@
-🌧️ Mizzling CLI
+# 🌧️ 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
+You can skip this and see a better documentation [here](https://mizzle-docs.vercel.app)
 
-# Using npm
+## 🚀 Installation
 
-npm install -D @aurios/mizzling
+You can install the CLI as a development dependency in your project using your preferred package manager, so let's get started:
 
-# Using pnpm
+```bash
+npm install @aurios/mizzling
+# or
+bun add @aurios/mizzling
+```
 
-pnpm add -D @aurios/mizzling
-
-The CLI is accessible via the mizzling command.
-🛠️ Commands
+## 🛠️ 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.
+1. `bunx mizzling init`: Initializes a new Mizzle configuration in your current directory. This is an interactive command that guides you through:
 
-    Usage: mizzling generate [--name <name>].
+- 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 automatically detects created, deleted, or updated tables.
+It generates a mizzle.config.ts file upon completion.
 
-    Creates a TypeScript migration file with up and down functions for version control.
+2. `bunx mizzling generate [--name <name>]`: Analyzes your current schema and compares it against the last saved snapshot to generate a new migration script.
 
-3. mizzling push
+It automatically detects created, deleted, or updated tables.
 
-Directly applies schema changes to your target DynamoDB environment without generating migration files.
+Creates a TypeScript migration file with up and down functions for version control.
 
-    Usage: mizzling push [-y, --yes].
+3. `bunx mizzling push [-y, --yes]`: Directly applies schema changes to your target DynamoDB environment without generating migration files.
 
-    The --yes flag skips the interactive confirmation prompt.
+The `--yes` flag skips the interactive confirmation prompt. Useful for rapid prototyping and synchronizing development environments.
 
-    Useful for rapid prototyping and synchronizing development environments.
+4. `bunx mizzling list`: Provides a summary of all existing DynamoDB tables in the configured environment.
 
-4. mizzling list
+For each table, it displays:
 
-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).
 
-    The table name.
+5. `bunx mizzling drop`: An interactive tool to safely remove tables from your environment.
 
-    Primary Key (PK) and Sort Key (SK) attributes.
+It fetches a list of remote tables and allows you to select multiple items for deletion.
 
-    A list of Global Secondary Indexes (GSIs).
+> Warning: This action is irreversible and requires explicit
+> confirmation before proceeding.
 
-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)
+## ⚙️ Configuration (mizzle.config.ts)
 
 Mizzling uses a central configuration file. You can use the defineConfig helper for full TypeScript type safety:
 TypeScript
 
+```ts
 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
+  schema: "./src/schema.ts",
+  out: "./migrations",
+  region: "us-east-1",
+  // endpoint: "http://localhost:8000", // Optional for local dev
 });
+```
 
-Environment Overrides
+## 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.
+- 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
+## 📄 License
 
 This project is licensed under the MIT License.

package/package.json

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