@@ -29,17 +29,21 @@ npx create-vorsteh-queue my-app -pm=yarn
2929npx create-vorsteh-queue my-app --quiet
3030npx create-vorsteh-queue my-app -q
3131
32- # Fully automated
32+ # Fully automated (no prompts)
3333npx create-vorsteh-queue my-app -t=drizzle-pglite -pm=pnpm --quiet
34+
35+ # Skip dependency installation
36+ npx create-vorsteh-queue my-app -t=drizzle-pglite --no-install --quiet
3437```
3538
3639## CLI Options
3740
38- | Option | Short | Description | Example |
39- | ------------------------ | ----------- | --------------- | ------------------- |
40- | ` --template=<name> ` | ` -t=<name> ` | Choose template | ` -t=drizzle-pglite ` |
41- | ` --package-manager=<pm> ` | ` -pm=<pm> ` | Package manager | ` -pm=pnpm ` |
42- | ` --quiet ` | ` -q ` | Minimal output | ` --quiet ` |
41+ | Option | Short | Description | Example |
42+ | ------------------------ | ----------- | ----------------------- | ------------------- |
43+ | ` --template=<name> ` | ` -t=<name> ` | Choose template | ` -t=drizzle-pglite ` |
44+ | ` --package-manager=<pm> ` | ` -pm=<pm> ` | Package manager | ` -pm=pnpm ` |
45+ | ` --no-install ` | - | Skip dependency install | ` --no-install ` |
46+ | ` --quiet ` | ` -q ` | Minimal output | ` --quiet ` |
4347
4448### Package Managers
4549
@@ -48,39 +52,19 @@ npx create-vorsteh-queue my-app -t=drizzle-pglite -pm=pnpm --quiet
4852- ** yarn** - Popular alternative
4953- ** bun** - Ultra-fast (experimental)
5054
51- ## Available Templates
55+ ## 📦 Available Templates
5256
53- Templates are ** dynamically discovered** from the GitHub repository:
57+ Templates are ** dynamically discovered** from the repository:
5458
55- - ** drizzle-postgres-example** - Advanced example using Drizzle ORM with postgres.js and recurring jobs
56- - ** drizzle-pg-example** - Basic example using Drizzle ORM with node-postgres (pg)
57- - ** drizzle-pglite-example** - Zero-setup example using Drizzle ORM with PGlite (embedded PostgreSQL)
58- - ** progress-tracking-example** - Real-time job progress tracking using Drizzle ORM with postgres.js
59- - ** event-system-example** - Comprehensive event monitoring and statistics using Drizzle ORM with postgres.js
59+ - ** drizzle-pg** - Basic example using Drizzle ORM with node-postgres (pg)
60+ - ** drizzle-pglite** - Zero-setup example using Drizzle ORM with PGlite (embedded PostgreSQL)
61+ - ** drizzle-postgres** - Advanced example using Drizzle ORM with postgres.js and recurring jobs
62+ - ** event-system** - Comprehensive event monitoring and statistics using Drizzle ORM with postgres.js
63+ - ** pm2-workers** - Manage multiple Vorsteh Queues with PM2 using Drizzle ORM with postgres.js
64+ - ** progress-tracking** - Real-time job progress tracking using Drizzle ORM with postgres.js
6065
6166> Templates are automatically fetched from the examples directory, so new examples are immediately available!
6267
63- ## Features
64-
65- - 🚀 ** Interactive CLI** - Beautiful prompts with @clack/prompts
66- - 📦 ** Dynamic templates** - Auto-discovered from GitHub repository
67- - 🔄 ** Latest versions** - Fetches current versions from npm registry
68- - 🎨 ** Colorful output** - Enhanced terminal experience with picocolors
69- - 🔗 ** Helpful links** - Direct links to documentation
70- - ⚡ ** Fast downloads** - Efficient template downloading with giget
71- - 🤫 ** Quiet mode** - Silent operation for automation
72- - 🛠️ ** Multiple package managers** - npm, pnpm, yarn, bun support
73- - 🎯 ** CLI flags** - Full automation support
74-
75- ## What it does
76-
77- 1 . ** Discovers templates** - Dynamically fetches available templates from GitHub
78- 2 . ** Prompts for details** - Name, template, package manager (if not provided via CLI)
79- 3 . ** Downloads template** - Uses giget to efficiently download from GitHub
80- 4 . ** Updates package.json** - Replaces workspace dependencies with latest npm versions
81- 5 . ** Installs dependencies** - Uses selected package manager
82- 6 . ** Provides guidance** - Shows next steps with correct commands
83-
8468## Examples
8569
8670### Interactive Usage
@@ -114,7 +98,8 @@ Next steps:
11498npx create-vorsteh-queue worker-service \
11599 --template=drizzle-postgres \
116100 --package-manager=pnpm \
117- --quiet
101+ --quiet \
102+ --no-install
118103```
119104
120105## Development
@@ -128,15 +113,4 @@ pnpm dev
128113
129114# Build for production
130115pnpm build
131-
132- # Test locally
133- npx tsx src/index.ts my-test-app
134116```
135-
136- ## Architecture
137-
138- - ** Dynamic Discovery** - Templates fetched from GitHub API
139- - ** Smart Caching** - giget handles efficient downloads
140- - ** Version Management** - npm registry API for latest versions
141- - ** Graceful Fallbacks** - Works offline with cached templates
142- - ** Cross-platform** - Works on Windows, macOS, Linux
0 commit comments