Getting Started

Installation

Sylph uses Node.js 24 LTS and pnpm 11 through Corepack:

corepack enable
corepack pnpm install --frozen-lockfile
cp .env.example .env.local
corepack pnpm dev

The development server is available at http://localhost:3000 by default.

Environment Variables

SITE_URL is the only required setting. It is the canonical HTTP or HTTPS origin for metadata, Open Graph images, robots.txt, and sitemap.xml.

SITE_URL=https://example.com

The value must be an origin without a path, query, or fragment. Production builds reject a missing or malformed value so they cannot publish broken canonical URLs.

Verification

The default checks never rewrite authored source. The composite command runs formatting, linting, types, unit tests, a production build, and the browser suite:

pnpm format:check
pnpm lint
pnpm typecheck
pnpm test
SITE_URL=https://example.com pnpm build
SITE_URL=https://example.com pnpm test:e2e

Run them together with:

SITE_URL=https://example.com pnpm verify

Source-writing operations remain explicit. Use pnpm format:write or pnpm lint:style:fix only when you intend to update files. Post timestamps are authored frontmatter and are never derived from filesystem timestamps during a build.