Installation

Prerequisites

• Node.js 22 or higher
• A frontend project with TypeScript

Install

# npm
npm install -D screenbook

# pnpm
pnpm add -D screenbook

# yarn
yarn add -D screenbook

Initialize

Run the init command to set up Screenbook in your project:

npx screenbook init

This will:

1. Auto-detect your framework (Next.js, Vite, Remix, Nuxt, Astro)
2. Create screenbook.config.ts with appropriate patterns
3. Add .screenbook to .gitignore

Verify Installation

Check that the CLI is working:

npx screenbook --help

You should see the list of available commands.

Next Steps

• Quick Start - Create your first screen definition
• Configuration - Customize Screenbook settings