CLI Commands

Screenbook provides a powerful CLI to manage your screen catalog.

Installation

npm install -D screenbook
# or
pnpm add -D screenbook

Commands

init

Initialize Screenbook in a project

generate

Auto-generate screen.meta.ts files from route files

build

Build screen metadata JSON from screen.meta.ts files

dev

Start the Screenbook development server

lint

Detect routes without screen.meta.ts files

impact

Analyze which screens depend on a specific API/service

pr-impact

Analyze impact of changed files in a PR

Global Options

All commands support the following global options:

Option	Description
--help, -h	Show help information
--version, -v	Show version number
--config, -c	Path to config file