create-gridland
v0.4.3
Published
Create a new Gridland project
Downloads
375
Readme
create-gridland
Scaffold a new Gridland project.
Gridland is a React framework for building terminal apps that also run in the browser — same source, same components, two runtime targets.
Usage
bunx create-gridland my-appYou'll be prompted to choose a template:
- CLI app — Bun-powered terminal app (
@gridland/bun) - Vite — Browser app that renders TUI components on an HTML canvas (
@gridland/web) - Next.js — Next.js site with embedded Gridland TUI components
Then:
cd my-app
bun install
bun devAdding components
After scaffolding, add Gridland components from the registry:
bunx create-gridland add spinner
bunx create-gridland add modal side-nav --yes
bunx create-gridland add spinner --dry-run # preview without runningComponents are fetched from https://gridland.io/r/{name}.json and written into your project via the shadcn CLI. Already-namespaced names (@gridland/modal) work too.
Documentation
Full docs at gridland.io/docs
