You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ By default, the CLI:
28
28
- Blocks non-`views://` renderer navigation unless `--navigation none` is passed.
29
29
- Includes the starter RPC example unless `--examples none` is passed.
30
30
- Includes a Bun test scaffold unless `--testing none` is passed.
31
-
- Supports optional app lock auth, seed data, Turborepo task running, static API mode, and multiple package managers.
31
+
- Supports optional app lock auth, settings persistence, seed data, Turborepo task running, static API mode, and multiple package managers.
32
32
- Writes `ces.json` in the generated project root with Better-T-Stack-style metadata, a reproducible command, selected stack fields, and feature flags for future CLI commands.
33
33
34
34
## Default Stack
@@ -49,6 +49,7 @@ By default, the CLI:
49
49
--database none
50
50
--orm none
51
51
--db-setup none
52
+
--settings none
52
53
--package-manager bun
53
54
--testing bun
54
55
--addons none
@@ -114,10 +115,10 @@ bun run format
114
115
115
116
## Generated Manifest
116
117
117
-
Every generated project includes `ces.json` at the project root. It uses a Better-T-Stack-inspired shape with `$schema`, `version`, `createdAt`, `reproducibleCommand`, project identifiers, flat stack fields such as `database`, `orm`, `frontend`, `addons`, `examples`, and a `features` map for future add-command checks.
118
+
Every generated project includes `ces.json` at the project root. It uses a Better-T-Stack-inspired shape with `$schema`, `version`, `createdAt`, `reproducibleCommand`, project identifiers, flat stack fields such as `database`, `orm`, `settings`, `frontend`, `addons`, `examples`, and a `features` map for future add-command checks.
118
119
119
120
## Current Scope
120
121
121
-
The implemented templates are `minimal`, `standard`, and `full`; `standard` and `full` currently use the same stable Electrobun template profile while keeping their manifest identity. Tailwind CSS and plain CSS are supported, `--ui shadcn` adds shadcn/ui project config when using Tailwind CSS, SQLite is supported, `--db-setup seed` adds starter metadata, and `--orm drizzle` adds Drizzle ORM when paired with `--database sqlite`. `--api none` omits runtime RPC wiring, `--auth app-lock` adds a local UI lock, and `--addons turborepo` adds Turbo task config. Electrobun-specific options include `--app-menu edit|none`, `--navigation local-only|none`, `--window-style native|hidden-inset`, `--build-env dev|canary|stable`, and `--build-targets current|all`. The default `--testing bun` adds a Bun test script and manifest smoke test; `--testing none` omits it. The default `--examples rpc` renders the starter RPC greeting/logging demo; `--examples none` keeps the typed RPC bridge but omits the demo calls and README section.
122
+
The implemented templates are `minimal`, `standard`, and `full`; `standard` and `full` currently use the same stable Electrobun template profile while keeping their manifest identity. Tailwind CSS and plain CSS are supported, `--ui shadcn` adds shadcn/ui project config when using Tailwind CSS, SQLite is supported, `--db-setup seed` adds starter metadata, and `--orm drizzle` adds Drizzle ORM when paired with `--database sqlite`. `--settings json` adds a VS Code-style `data/settings.json` store, and `--settings database` stores the same settings through SQLite when paired with `--database sqlite`. `--api none` omits runtime RPC wiring, `--auth app-lock` adds a local UI lock, and `--addons turborepo` adds Turbo task config. Electrobun-specific options include `--app-menu edit|none`, `--navigation local-only|none`, `--window-style native|hidden-inset`, `--build-env dev|canary|stable`, and `--build-targets current|all`. The default `--testing bun` adds a Bun test script and manifest smoke test; `--testing none` omits it. The default `--examples rpc` renders the starter RPC greeting/logging demo; `--examples none` keeps the typed RPC bridge but omits the demo calls and README section.
122
123
123
124
The CLI uses `@clack/prompts` for interactive prompts, spinners, and cancellation handling.
Copy file name to clipboardExpand all lines: docs/cli.md
+17-1Lines changed: 17 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ bun run src/index.ts <project-name> [options]
30
30
31
31
## Generated Manifest
32
32
33
-
The CLI writes `ces.json` in the generated project root. The manifest follows a Better-T-Stack-inspired shape with `$schema`, `version`, `createdAt`, `reproducibleCommand`, project identifiers, flat stack fields such as `database`, `orm`, `frontend`, `addons`, `examples`, and `features` booleans for integrations such as `shadcn`, `sqlite`, `drizzle`, `bunTest`, `appLock`, and `turborepo`.
33
+
The CLI writes `ces.json` in the generated project root. The manifest follows a Better-T-Stack-inspired shape with `$schema`, `version`, `createdAt`, `reproducibleCommand`, project identifiers, flat stack fields such as `database`, `orm`, `settings`, `frontend`, `addons`, `examples`, and `features` booleans for integrations such as `shadcn`, `sqlite`, `drizzle`, `bunTest`, `appLock`, `settingsStore`, and `turborepo`.
34
34
35
35
## Stack Options
36
36
@@ -53,6 +53,7 @@ These options intentionally mirror the shape of stack scaffolders like `better-t
53
53
|`--database`|`none`, `sqlite`| implemented |
54
54
|`--orm`|`none`, `drizzle`|`drizzle` implemented with SQLite |
Copy file name to clipboardExpand all lines: docs/templates.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ Includes:
18
18
- Native or hidden-inset window chrome through `--window-style`
19
19
- Optional Bun test scaffold through `--testing bun`
20
20
- Optional app lock through `--auth app-lock`
21
+
- Optional JSON or database settings persistence through `--settings`
21
22
- Optional Turborepo config through `--addons turborepo`
22
23
- Typed Electrobun RPC bridge
23
24
- Optional starter RPC example through `--examples rpc`
@@ -42,6 +43,11 @@ templates/minimal/
42
43
orm/
43
44
drizzle/
44
45
**/*.hbs
46
+
settings/
47
+
json/
48
+
**/*.hbs
49
+
database/
50
+
**/*.hbs
45
51
testing/
46
52
bun/
47
53
**/*.hbs
@@ -55,6 +61,8 @@ The default `--testing bun` adds `bun test`, includes `tests` in `tsconfig.json`
55
61
56
62
Passing `--api none` omits BrowserWindow RPC wiring. Passing `--auth app-lock` renders a local app-name lock screen. Passing `--db-setup seed` with SQLite inserts starter metadata when the database is empty. Passing `--addons turborepo` adds `turbo.json`, a `check` script, and the Turbo dev dependency.
57
63
64
+
Passing `--settings json` adds a Bun-side settings store backed by `data/settings.json`, with VS Code-style dotted keys such as `app.theme`. Passing `--settings database` stores the same key/value settings in SQLite and requires `--database sqlite`. Both settings modes expose `getSettingsStatus` and `updateSetting` through the typed Electrobun RPC bridge.
65
+
58
66
The default `--examples rpc` renders a greeting/logging RPC demo in the route, handlers, shared RPC schema, and generated README. Passing `--examples none` keeps the typed RPC bridge and environment request but omits that demo surface.
0 commit comments