Getting startedMIT · agent-agnostic

Getting started

Install and generate your first pack

Clone the public repo, run the CLI in your app directory, and produce ./build-pack/ — then hand it to your agent and score the result.

Requirements

ToolVersionWhy
Node.js18+Runs the DZINE CLI and MCP server
Python3.10+Compiles contracts, lint, score, validation
GitanyClone the repo (optional if using npx only)

Install

npm (recommended)

npm (recommended)
npx dzine-skill

Clone repo (contributors)

Clone repo (contributors)
git clone https://github.com/chasesdavis/DZINE.git && cd DZINE

Fastest path (repo clone)

Five-minute smoke test
./scripts/first-run.sh
Stranger test (install-doc simulation)
./scripts/stranger-test.sh

Writes a pack to starters/dzine-starter/build-pack/. See Advanced for strict scoring and the standalone starter export.

Generate your first pack

cd into your application directory. The pack is written to ./build-pack/ in your current directory.

From your app directory
npx dzine-skill run "homepage for a secure AI research notebook with proof-first hero" --write-build-pack

What gets written

PathRole
build-pack/contract/design-contract.jsonCanonical DesignContract v1 — lint and score target
build-pack/contract/DESIGN.mdAgent-readable contract (structured Markdown)
build-pack/contract/route.jsonSection jobs and acceptance criteria
build-pack/contract/tokens.cssSemantic visual constraints
build-pack/contract/scorecard.mdPass/fail gates after implementation
build-pack/contract/contract-preview.htmlHuman dossier for review
build-pack/01-plan.mdCompiled plan from brief intelligence
build-pack/route-kits/Route-specific section kit
build-pack/manifest.jsonMachine-readable index of copied assets

Hand off to an agent

Commit build-pack/ beside your app, or paste into project rules. Minimum instruction:

Use ./build-pack as the design source of truth.
Implement from contract/DESIGN.md and route.json.
Do not invent a new visual system.
After the first build, run the scorecard and fix every failed row.

Agent-specific patterns: Agent handoff.

Verify end-to-end

Lint contract
npx dzine-skill lint build-pack/contract/design-contract.json
Score (structural v0)
npx dzine-skill score --contract build-pack/contract/design-contract.json --url http://localhost:3003 --out build-pack/score-report.json
Score (strict + browser preflight)
npx dzine-skill score --contract build-pack/contract/design-contract.json --url http://localhost:3003 --strict --out build-pack/score-report.json
Repair failed clauses
npx dzine-skill repair --contract build-pack/contract/design-contract.json --scorecard build-pack/score-report.json --out build-pack/repair-prompt.md

Start the docs site with cd site && npm run dev (port 3003) before scoring localhost. Read What is DZINE? for the full mental model.