Create a project

Create a circuit documentation project from npm, or use local tarballs before the first release.

Before the first npm release: create-zudo-circuit-doc and @takazudo/zudo-circuit-doc are not yet published on npm. Both package names returned 404 from npm view on 2026-09-27. Use the from-source route below for now.

Once both packages are available on npm, create a project with:

pnpm create zudo-circuit-doc my-circuit
cd my-circuit
pnpm circuit:doctor
pnpm dev

The initializer installs dependencies and creates an initial Git commit by default. Open the local address printed by pnpm dev; a new project starts with an empty component catalog. Continue with the first run and the first task. For names, agent choices, and other options, see the initializer CLI reference.

Before the first npm release

You can build and pack both packages from a checkout of Takazudo/zudo-circuit-doc. Run these commands from the repository root:

corepack pnpm install
mkdir -p /tmp/zudo-circuit-doc-tarballs
corepack pnpm --filter @takazudo/zudo-circuit-doc build
corepack pnpm --filter @takazudo/zudo-circuit-doc pack --pack-destination /tmp/zudo-circuit-doc-tarballs
corepack pnpm --filter create-zudo-circuit-doc build
corepack pnpm --filter create-zudo-circuit-doc pack --pack-destination /tmp/zudo-circuit-doc-tarballs

This creates takazudo-zudo-circuit-doc-0.1.0.tgz and create-zudo-circuit-doc-0.1.0.tgz in the scratch directory. From outside the repository, run:

pnpm dlx /tmp/zudo-circuit-doc-tarballs/create-zudo-circuit-doc-0.1.0.tgz my-circuit \
  --name my-circuit --title "My Circuit" --no-git \
  --runtime-spec file:/tmp/zudo-circuit-doc-tarballs/takazudo-zudo-circuit-doc-0.1.0.tgz
cd my-circuit
pnpm circuit:doctor
pnpm dev

The absolute file: path makes the initializer write the local runtime tarball into both the root package.json and doc/package.json. The default --install option runs pnpm install as part of project creation, so there is no separate install step. The example uses --no-git so a temporary trial does not create a commit; omit it if you want the initial commit.

pnpm circuit:doctor should report node, config, and python as ok. Optional tools may show as missing. The first run explains those results.