create-coral CLI

What it is

create-coral is the official Coral scaffolding CLI. It pulls the latest template/, renames the module for you, and keeps the standard Coral setup intact:

TypeScript by default
Biome for linting and formatting
Coral release automation and workflow files
TanStack Start, Tailwind CSS, and Jellyfin-ready structure

Create a Module

Use whichever package manager you prefer:

pnpm create coral@latest
npm create coral@latest
bun create coral@latest

You can also pass the module name directly:

pnpm create coral@latest my-module
npm create coral@latest my-module
bun create coral@latest my-module

If you want the explicit package form:

npx create-coral@latest my-module

What the CLI Sets Up

The generated module already includes:

TypeScript configuration
Biome formatting and linting
Vite and TanStack Start wiring
Dockerfile and production server wrapper
GitHub workflows for CI and release automation

Interactive Flow

If you run the CLI without a target directory, it guides you through:

target directory
module name
whether dependencies should be installed immediately

After Scaffolding

cd my-module
pnpm install
cp .env.example .env
pnpm dev

Most Coral modules run locally on port 3000 by default unless you override it.

When to Use the Template Manually

The CLI is the recommended path. Manual cloning of Get-Coral/template is mainly useful if you need to inspect or fork the raw starter before generating a module.