create-taserjs 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -9
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,24 +1,61 @@
1
1
  # create-taserjs
2
2
 
3
- Scaffold a new Taser application
3
+ Official scaffolding CLI for [Taser](https://taserjs.dev) REST API projects.
4
4
 
5
- ## Usage
5
+ ## Quick Start
6
6
 
7
- **npm:**
7
+ ### Interactive Mode
8
8
 
9
9
  ```bash
10
- npm create taserjs@latest
11
- pnpm create taserjs@latest
10
+ # npm
11
+ npm create taserjs@latest my-api
12
+
13
+ # pnpm
14
+ pnpm create taserjs@latest my-api
15
+
16
+ # bun
17
+ bun create taserjs@latest my-api
18
+
19
+ # yarn
20
+ yarn create taserjs my-api
12
21
  ```
13
22
 
14
- **JSR:**
23
+ ### Non-Interactive / CI Mode
24
+
25
+ Pass flags to scaffold immediately without prompts:
15
26
 
16
27
  ```bash
17
- npx jsr @taserjs/create
28
+ pnpm create taserjs@latest my-api \
29
+ --framework express \
30
+ --preset node-server \
31
+ --db drizzle:postgres \
32
+ --validator zod \
33
+ --logger pino \
34
+ -y
18
35
  ```
19
36
 
20
- This will scaffold a new Taser application with your choice of deployment preset and optional add-ons.
37
+ ## CLI Flags
38
+
39
+ | Flag | Description | Supported Values | Default |
40
+ | :--------------- | :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------- |
41
+ | `--framework` | Host framework | `none`, `hono`, `express`, `fastify` | `none` |
42
+ | `--preset`, `-p` | Deployment preset (Nitro preset or `none`) | `none`, `node-server`, `node-cluster`, `bun`, `deno-server`, `deno-deploy`, `cloudflare-module`, `vercel`, `aws-lambda`, `netlify` | `node-server` |
43
+ | `--runtime` | Explicit runtime override (for self-hosted targets) | `node`, `bun`, `deno` | Preset default |
44
+ | `--db` | Database ODM and driver syntax (`odm:driver`) | `drizzle`, `prisma`, `kysely` with `:sqlite`, `:postgres`, `:mysql` | None (driver defaults to `sqlite`) |
45
+ | `--validator` | Schema validation library | `zod`, `arktype`, `valibot` | None |
46
+ | `--logger` | Structured logger integration | `pino`, `winston` | None |
47
+ | `-y`, `--yes` | Skip prompts and accept defaults for omitted flags | `boolean` | `false` |
48
+ | `--noInstall` | Skip automatic package manager install step | `boolean` | `false` |
49
+ | `--json` | Machine-readable JSON output (dumps catalog if no name) | `boolean` | `false` |
50
+
51
+ ## Programmatic / Machine Inspection
52
+
53
+ Inspect all supported catalog dimensions and options in JSON:
54
+
55
+ ```bash
56
+ npx create-taserjs --json
57
+ ```
21
58
 
22
59
  ## License
23
60
 
24
- ISC
61
+ ISC — Copyright (c) 2026, Kazi Ahmed & Taser contributors.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-taserjs",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Scaffold a new Taser application",
5
5
  "license": "ISC",
6
6
  "repository": {
@@ -32,7 +32,7 @@
32
32
  "typescript": "^5.9.3",
33
33
  "vite": "^8.1.5",
34
34
  "vitest": "^4.1.10",
35
- "@taserjs/router-generator": "0.1.3"
35
+ "@taserjs/router-generator": "0.1.4"
36
36
  },
37
37
  "engines": {
38
38
  "node": ">=20.19"