Getting Started
A framework for building terminal apps, built on OpenTUI + React. Gridland apps work in the browser and terminal.
Gridland renders terminal-style UIs directly to an HTML5 Canvas using React. Built on the opentui engine. No xterm.js, no terminal emulator, just a React reconciler, Yoga layout, and canvas pixels.
Start a new project
Scaffold a new Gridland app with everything pre-configured:
bunx create-gridland my-appnpx create-gridland my-appyarn create gridland my-apppnpm create gridland my-appAdd to an existing project
Choose your framework:
Vite
Quickest setup — one plugin, zero config.
Next.js
For server-rendered apps using the App Router.
Custom Bundler
Webpack, Rollup, or any other bundler.
Install components
Gridland UI components are distributed via a shadcn registry. Install individual components into your project so you own the code and can customize it freely.
bunx shadcn@latest add @gridland/spinnerSee the Installing Components guide for setup instructions and the full list of available components.