create-celestial

Scaffold a modern TypeScript TUI app powered by Celestial.

Usage

npm create celestial my-app
cd my-app
pnpm install
pnpm dev

Pick the template non-interactively (scripts and CI welcome):

npm create celestial my-app -- --template tsx-app
# or
pnpm dlx create-celestial my-app tsx-app

--help and --version are supported.

Templates

Template	What you get
counter-tea	Clean Elm-architecture starter: model, update, view, keyboard subscriptions
tsx-app	Declarative TSX starter with <Box>, <Text>, clickable <Button>s, and flex layouts
ai-assistant	Agent-style TUI with an interactive tool execution card and a syntax-highlighted diff viewer
minimal-prompt	Clack/Inquirer-style inline CLI prompts that preserve scrollback

Every template scaffolds a package.json, tsconfig.json (preconfigured for the Celestial JSX transform via jsxImportSource: "@celestial/core"), a README, a runnable src/ entry point, a headless test suite using @celestial/test, and a GitHub Actions CI workflow that typechecks and runs it on every push.

Requirements

Node.js 22 or newer.