Skip to content

Quick Start

All commands run from the repository root using pnpm.

Install

bash
pnpm install

Build, test, and lint

bash
pnpm build       # builds the workspace
pnpm test        # runs all tests
pnpm lint        # runs lint and type checks

Docs site

bash
pnpm docs:dev      # start the VitePress dev server
pnpm docs:build    # build the static site to docs/build
pnpm docs:preview  # preview the production build
pnpm docs:generate # regenerate the CLI reference catalogue

Engine

bash
pnpm --filter @daily-rule/engine test              # run engine tests
pnpm --filter @daily-rule/engine test:puzzle        # run the engine CLI
pnpm runtime:status -- --as-of=2026-07-01           # inspect active runtime
pnpm runtime:rebuild -- --as-of=2026-07-01 --days=30
pnpm benchmark:runtime -- --as-of=2026-07-01 --days=14

Content

bash
pnpm content:validate            # validate themes and registry
pnpm content:simulate -- --days=14 --from=2026-07-01

Content CLI

bash
pnpm content-cli create <theme>                                    # scaffold a new theme
pnpm content-cli import <theme> <word-list-path> [--report-json <path>]
pnpm content-cli analyze <theme> [--report-json <path>]            # editorial diagnostics
pnpm content-cli refresh <theme>                                   # regenerate metadata
pnpm season:create                                                 # create a season (interactive)
pnpm season:validate                                               # validate season config
pnpm content:benchmark                                             # authoring benchmarks

Historical snapshots

bash
pnpm historical:snapshot -- check --as-of=2026-07-01
pnpm historical:snapshot:check
pnpm historical:snapshot:clean

Releases

bash
pnpm release:dry-run
pnpm release:web:dry-run

Package-scoped commands

bash
pnpm --filter @daily-rule/web dev        # start the web app
pnpm --filter @daily-rule/api dev        # start the API
pnpm --filter @daily-rule/docs dev       # start the docs site
pnpm --filter @daily-rule/web test
pnpm --filter @daily-rule/api test
pnpm --filter @daily-rule/engine test
pnpm --filter @daily-rule/docs build
pnpm --filter @daily-rule/web lint
pnpm --filter @daily-rule/api lint
pnpm --filter @daily-rule/engine lint
pnpm --filter @daily-rule/content-cli cli <command> [options]

For detailed documentation of each area, use the sidebar navigation.

The Daily Rule engineering, authoring, editorial, and operations handbook.