@surfaice/cli

CLI tool for managing Surfaice UI manifests — export, check drift, and diff changes.

Install

npm install -g @surfaice/cli
# or use without installing:
npx @surfaice/cli

Commands

surfaice export

Fetch routes from a running app and save .surfaice.md files.

surfaice export -u http://localhost:3000 -r /settings /dashboard -o ./surfaice/

surfaice check

Compare committed .surfaice.md files against the live app. Exit code 1 on drift — CI-ready.

surfaice check -u http://localhost:3000 -d ./surfaice/
# ✅ /settings — 6 elements match
# ❌ /dashboard — DRIFT: 1 added, 1 changed

surfaice diff

Show human-readable or JSON diff between committed and live.

surfaice diff -u http://localhost:3000 -d ./surfaice/
surfaice diff -u http://localhost:3000 -d ./surfaice/ --json

CI Integration

# .github/workflows/surfaice.yml
- name: Check for UI drift
  run: surfaice check -u ${{ env.APP_URL }} -d ./surfaice/