@themuneebh-oss/tbk

CLI tool for TypeScript Backend Toolkit projects. Generate modules, plugins, middleware, seeders, and factories with a single command.

Installation

This package is typically installed as a dev dependency in TypeScript Backend Toolkit projects:

``bash
pnpm add -D @themuneebh-oss/tbk
`

Or via npm:

`bash
npm install -D @themuneebh-oss/tbk
`

Usage

After installation, use the tbk command:

`bash


Generate a complete module

pnpm tbk generate:module [--path /api/v1]

Generate a plugin

pnpm tbk generate:plugin

Generate middleware

pnpm tbk generate:middleware

Run database seeders

pnpm tbk seed [--group dev] [--only SeederName] [--fresh]

Create a seeder for a module

pnpm tbk make:seeder / [--count 5] [--unique field]

Create a factory for a module

pnpm tbk make:factory / [--model ExportName]
`

Commands

$3

Generate a complete module with all files (dto, model, schema, services, controller, router).

`bash
pnpm tbk generate:module user
pnpm tbk generate:module product --path /api/v1
`

Options:

- -p, --path - API path prefix (default: /api)

Creates:

- src/modules//.dto.ts - Zod schemas and TypeScript types
- src/modules//.model.ts - Mongoose model
- src/modules//.schema.ts - Request/response validation schemas
- src/modules//.services.ts - Business logic and data access
- src/modules//.controller.ts - HTTP request handlers
- src/modules//.router.ts - MagicRouter route definitions

$3

Generate a new plugin with the standard structure.

`bash
pnpm tbk generate:plugin cache
`

Creates:

- src/plugins//index.ts - Plugin factory and registration

$3

Generate a new Express middleware.

`bash
pnpm tbk generate:middleware rateLimiter
`

Creates:

- src/middlewares/.ts - Middleware function

$3

Run database seeders to populate test data.

`bash


Run all seeders in dev group

pnpm tbk seed

Run specific seeders

pnpm tbk seed --only UserSeeder,ProductSeeder

Fresh run (drops collections)

pnpm tbk seed --fresh

Dry run (no writes)

pnpm tbk seed --dry-run

Force run in production

pnpm tbk seed --force
`

Options:

- -g, --group - Group to run (base|dev|test|demo) (default: dev)
- --only - Comma-separated seeder names
- --fresh - Drop involved collections before seeding
- --force - Force run in production
- --dry-run - Do not write, only log actions
- --seed - Random seed for data generation (default: 1)
- --no-transaction - Disable transactions

$3

Scaffold a new seeder for a module. Automatically detects model fields and dependencies.

`bash
pnpm tbk make:seeder user/User
pnpm tbk make:seeder product/Product --count 10 --unique slug
`

Options:

- -c, --count - Default count for dev/test (default: 5)
- -u, --unique - Unique field to upsert by
- -d, --depends-on - Comma-separated additional dependencies
- --model - Model export name when not default

Creates:

- src/modules//seeders/Seeder.ts

Note: The seeder must be manually registered in src/seeders/registry.ts.

$3

Scaffold a new factory for a module. Automatically detects model fields and create functions.

`bash
pnpm tbk make:factory user/User
pnpm tbk make:factory product/Product --model ProductModel --use service
`

Options:

- --model - Model export name when not default
- --use - Prefer using service create function when present (default: service)
- --id-type - Hint for \_id type when ambiguous

Creates:

- src/modules//factories/.factory.ts

Requirements

- Node.js >= 18.0.0
- TypeScript Backend Toolkit project structure
- MongoDB connection (for seed command)

How It Works

The CLI tool uses dynamic imports and model introspection to:

- Analyze Mongoose schemas to detect fields, types, and relationships
- Generate type-safe code following project patterns
- Ensure consistency with existing codebase structure

Development

`bash


Build the package

pnpm build

Watch mode

pnpm dev

Type check

pnpm typecheck
``

License

MIT

Links

- Main Toolkit Repository
- Report Issues