Merge pull request #191 from RtlZeroMemory/feat/starship-template

feat(create-rezi): add starship command console template

Author: RtlZeroMemory

README.md

@@ -132,7 +132,7 @@ cd my-app
 bun start
 ```
 
-Starter templates: **dashboard**, **stress-test**, **cli-tool**, **animation-lab**, and **minimal**.
+Starter templates: **dashboard**, **stress-test**, **cli-tool**, **animation-lab**, **minimal**, and **starship** (command console).
 
 ---
 

docs/dev/repo-layout.md

@@ -93,7 +93,7 @@ terminal.
 
 CLI scaffolding tool. Running `npm create rezi` generates a new Rezi project
 from built-in templates with proper `package.json`, `tsconfig.json`, and example
-code. Current templates: `dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`.
+code. Current templates: `dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`.
 
 ### bench -- `@rezi-ui/bench` (private)
 

docs/getting-started/create-rezi.md

@@ -34,6 +34,9 @@ If `--template` is omitted, the CLI prompts you to choose (default: `dashboard`)
 - `minimal`: Single-screen utility starter for focused tooling.
   Highlights: lean reducer flow, keybindings (`q`, `?`, `+/-`, `t`), theme cycling, and signal-safe shutdown pattern.
   Aliases: `mini`, `basic`, `utility`.
+- `starship`: Multi-deck command console integration showcase.
+  Highlights: routed six-screen bridge, live telemetry/charts, crew and cargo operations, overlays, and theme cycling.
+  Aliases: `ship`, `bridge`, `command`.
 
 Choose directly with `--template`:
 
@@ -43,11 +46,13 @@ npm create rezi my-app -- --template stress-test
 npm create rezi my-app -- --template cli-tool
 npm create rezi my-app -- --template animation-lab
 npm create rezi my-app -- --template minimal
+npm create rezi my-app -- --template starship
 bun create rezi my-app -- --template dashboard
 bun create rezi my-app -- --template stress-test
 bun create rezi my-app -- --template cli-tool
 bun create rezi my-app -- --template animation-lab
 bun create rezi my-app -- --template minimal
+bun create rezi my-app -- --template starship
 ```
 
 Inspect all templates and highlights from the CLI:
@@ -61,7 +66,7 @@ bun create rezi -- --list-templates
 ## Options
 
 - `--template, -t <name>`:
-  Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`; aliases: `dash`, `stress`, `chaos`, `bench`, `cli`, `tool`, `multiscreen`, `animation`, `anim`, `lab`, `motion`, `mini`, `basic`, `utility`).
+  Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`; aliases: `dash`, `stress`, `chaos`, `bench`, `cli`, `tool`, `multiscreen`, `animation`, `anim`, `lab`, `motion`, `mini`, `basic`, `utility`, `ship`, `bridge`, `command`).
 - `--no-install, --skip-install`: Skip dependency installation.
 - `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
 - `--list-templates, --templates`: Print available templates and highlights.
@@ -85,13 +90,13 @@ Each template includes example tests for reducer logic, widget rendering, and ke
 
 ## Dev Loop (HSR)
 
-`minimal`, `dashboard`, and `cli-tool` templates ship with hot state-preserving reload enabled in
+`minimal`, `dashboard`, `cli-tool`, and `starship` templates ship with hot state-preserving reload enabled in
 `npm run dev` / `bun run dev`:
 
 - dev script runs `tsx src/main.ts --hsr`
 - source changes hot-swap through `createNodeApp({ hotReload: ... })` via:
   - `app.replaceView(...)` in widget-view templates (`minimal`, `dashboard`)
-  - `app.replaceRoutes(...)` in route-managed template (`cli-tool`)
+  - `app.replaceRoutes(...)` in route-managed templates (`cli-tool`, `starship`)
 - app state, focus, and stable widget local state are preserved across edits
 
 For package-level CLI reference (invocation forms and options), see [packages/create-rezi](../packages/create-rezi.md).

docs/getting-started/examples.md

@@ -29,7 +29,7 @@ node examples/raw-draw-demo/dist/index.js
 
 ## Looking for Larger App Examples?
 
-Use `create-rezi` templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`) for full starter apps:
+Use `create-rezi` templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`) for full starter apps:
 
 - [Create Rezi (canonical template overview)](create-rezi.md)
 - [create-rezi package reference](../packages/create-rezi.md)

docs/getting-started/quickstart.md

@@ -20,15 +20,16 @@ cd my-tui-app
 bun start
 ```
 
-Select a template when prompted (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, or `minimal`), or pass `--template` to choose directly:
+Select a template when prompted (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, or `starship`), or pass `--template` to choose directly:
 
 ```bash
 npm create rezi my-tui-app -- --template dashboard
 npm create rezi my-tui-app -- --template animation-lab
 npm create rezi my-tui-app -- --template minimal
+npm create rezi my-tui-app -- --template starship
 ```
 
-The templates demonstrate the recommended project structure and patterns. Start with `minimal` to learn the basics, `dashboard` for operations workflows, or `animation-lab` for declarative motion patterns.
+The templates demonstrate the recommended project structure and patterns. Start with `minimal` to learn the basics, `dashboard` for operations workflows, `animation-lab` for declarative motion patterns, or `starship` for an end-to-end command console showcase.
 
 ### Option 2: Manual setup
 

docs/packages/create-rezi.md

@@ -29,6 +29,7 @@ Canonical template names:
 - `cli-tool` (aliases: `cli`, `tool`, `multiscreen`)
 - `animation-lab` (aliases: `animation`, `anim`, `lab`, `motion`)
 - `minimal` (aliases: `mini`, `basic`, `utility`)
+- `starship` (aliases: `ship`, `bridge`, `command`)
 
 `animation-lab` is the canonical reference for Rezi's declarative motion APIs (`useTransition`, `useSpring`, `useSequence`, `useStagger`) plus `ui.box` transition props.
 
@@ -39,12 +40,14 @@ npm create rezi my-app -- --template dashboard
 npm create rezi my-app -- --template cli-tool
 npm create rezi my-app -- --template animation-lab
 npm create rezi my-app -- --template minimal
+npm create rezi my-app -- --template starship
 
 # Bun
 bun create rezi my-app -- --template dashboard
 bun create rezi my-app -- --template cli-tool
 bun create rezi my-app -- --template animation-lab
 bun create rezi my-app -- --template minimal
+bun create rezi my-app -- --template starship
 ```
 
 List templates and highlights:
@@ -59,12 +62,12 @@ For full template descriptions and highlights, use: [Getting Started -> Create R
 
 Template dev workflow notes:
 
-- `minimal`, `dashboard`, and `cli-tool` templates run `tsx src/main.ts --hsr` for `npm run dev` / `bun run dev`.
+- `minimal`, `dashboard`, `cli-tool`, and `starship` templates run `tsx src/main.ts --hsr` for `npm run dev` / `bun run dev`.
 - This enables in-process hot state-preserving reload through `@rezi-ui/node` `createNodeApp({ hotReload: ... })`.
 
 ## Options
 
-- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, plus aliases).
+- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`, plus aliases).
 - `--no-install, --skip-install`: Skip dependency installation.
 - `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
 - `--list-templates, --templates`: Print available templates and highlights.

docs/packages/index.md

@@ -114,7 +114,7 @@ bun add -d @rezi-ui/testkit
 
 **Project scaffolding CLI**
 
-Generate a ready-to-run Rezi app with TypeScript configured and polished starter templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`):
+Generate a ready-to-run Rezi app with TypeScript configured and polished starter templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`):
 
 ```bash
 npm create rezi my-app

packages/create-rezi/README.md

@@ -29,13 +29,16 @@ Currently available templates:
   - Aliases: `animation`, `anim`, `lab`, `motion`
 - `minimal` - Single-screen utility starter for small tools
   - Aliases: `mini`, `basic`, `utility`
+- `starship` - Starship command console starter with routed multi-deck operations
+  - Aliases: `ship`, `bridge`, `command`
 
 ```bash
 npm create rezi my-app -- --template dashboard
 npm create rezi my-app -- --template stress-test
 npm create rezi my-app -- --template cli-tool
 npm create rezi my-app -- --template animation-lab
 npm create rezi my-app -- --template minimal
+npm create rezi my-app -- --template starship
 ```
 
 List templates and highlights from the CLI:
@@ -46,7 +49,7 @@ npm create rezi -- --list-templates
 
 ## Options
 
-- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, plus aliases).
+- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`, plus aliases).
 - `--no-install, --skip-install`: Skip dependency installation.
 - `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
 - `--list-templates, --templates`: Print available templates and highlights.

packages/create-rezi/src/__tests__/scaffold.test.ts

@@ -29,10 +29,21 @@ test("normalizeTemplateName accepts friendly aliases", () => {
   assert.equal(normalizeTemplateName("mini"), "minimal");
   assert.equal(normalizeTemplateName("basic"), "minimal");
   assert.equal(normalizeTemplateName("utility"), "minimal");
+  assert.equal(normalizeTemplateName("starship"), "starship");
+  assert.equal(normalizeTemplateName("ship"), "starship");
+  assert.equal(normalizeTemplateName("bridge"), "starship");
+  assert.equal(normalizeTemplateName("command"), "starship");
 });
 
 test("template keys match template directories and include highlights", async () => {
-  const expectedKeys = ["dashboard", "stress-test", "cli-tool", "animation-lab", "minimal"];
+  const expectedKeys = [
+    "dashboard",
+    "stress-test",
+    "cli-tool",
+    "animation-lab",
+    "minimal",
+    "starship",
+  ];
   const keys = TEMPLATE_DEFINITIONS.map((template) => template.key);
   assert.equal(keys.join(","), expectedKeys.join(","));
 

packages/create-rezi/src/index.ts

@@ -88,7 +88,7 @@ function printHelp(): void {
   stdout.write("  bun create rezi my-app\n\n");
   stdout.write("Options:\n");
   stdout.write(
-    "  --template, -t <name>       dashboard | stress-test | cli-tool | animation-lab | minimal\n",
+    "  --template, -t <name>       dashboard | stress-test | cli-tool | animation-lab | minimal | starship\n",
   );
   stdout.write("  --no-install                Skip dependency install\n");
   stdout.write("  --pm <npm|pnpm|yarn|bun>    Choose a package manager\n");