drizzle-start
v1.0.7
Published
CLI tool for initializing Drizzle ORM projects
Maintainers
Readme
🧱 drizzle-start
An interactive CLI tool for quick setup of Drizzle ORM in TypeScript projects. Supports PostgreSQL, MySQL, and SQLite with both Bun and Node.js runtimes.
✨ Key Features
- 🚀 Interactive setup wizard
- 💾 Multi-database support (PostgreSQL, MySQL, SQLite)
- 📁 Customizable project structure
- 🔄 Automatic dependency installation
- 🧪 Built-in connection testing
- ⚡ Bun-first with Node.js support
🚀 Quick Start
# Using bunx (recommended)
bunx drizzle-start
# Using npx
npx drizzle-startInstall in Project
# Bun (recommended)
bun add -D drizzle-start
# npm/yarn/pnpm
npm install -D drizzle-start
yarn add -D drizzle-start
pnpm add -D drizzle-startRun from Project
bun drizzle-start # Using Bun
npm exec drizzle-start
yarn drizzle-start
pnpm drizzle-start📁 Project Structure
The CLI creates the following structure (customizable during setup):
your-project/
├── src/
│ └── database/
│ ├── db.ts # Database client
│ ├── schema/ # Schema definitions
│ │ └── index.ts
│ ├── migrations/ # Migration files
│ └── tests/ # Connection tests
├── .env # Database config
└── drizzle.config.ts # Drizzle config⚙️ Configuration
Environment Variables
DB_TYPE=pg|mysql|sqlite
DB_URL=your-connection-stringNPM Scripts
{
"scripts": {
"db:generate": "drizzle-kit generate",
"db:push": "drizzle-kit push",
"db:drop": "drizzle-kit drop",
"db:check": "drizzle-kit check"
}
}🔧 Requirements
- Bun (recommended) or Node.js 16+
- TypeScript 4+
🛠️ Development
# Clone repository
git clone https://github.com/yourusername/drizzle-start.git
# Install dependencies
bun install
# Development mode
bun dev
# Build project
bun run build📄 License
MIT © [Hicham Jebara]
💖 Credits
- Clack - Interactive CLI
- Drizzle ORM - Database toolkit
- pm-ninja - Package management
🔑 Keywords
drizzledrizzle-ormtypescriptclidatabaseormpostgresqlmysqlsqlitebunnodejsscaffoldingboilerplatestartersetupwizardinteractivemigrationsschemadatabase-toolkitdevelopment-tools
