create-zudo-doc CLI

create-zudo-doc プロジェクトスキャフォルダーの完全な CLI リファレンス。

使い方

create-zudo-doc [project-name] [options]

フラグなしで実行すると、対話式ウィザードが起動します。すべてのオプションはフラグで指定でき、非対話的（CI/エージェント）に使用できます。

セットアッププリセットジェネレーターを使って、対話的に設定を構成し、JSON プリセットまたは CLI コマンドとしてコピーすることもできます。

CLI が生成するもの

スキャフォールドは最小限で、ファイル数はおよそ12個です（プロジェクト構成を参照）。レイアウト、クローム、スキーマはすべて @takazudo/zudo-doc から出荷され、node_modules から消費されるため、生成されるプロジェクトが持つのは本当に固有のものだけです。

機能の選択は単一の zfb.config.ts に zudoDoc({ … }) 呼び出しとして書き込まれ、デフォルトと異なるフィールドだけを含みます（siteName は常に出力されます）。別個の src/config/settings.ts はありません — 唯一の設定ファイルが設定サーフェス全体です。各フィールドについては 設定 を参照してください。

新しいスキャフォールドが意図的に含まないものがいくつかあります:

• .zudo-doc.json なし — eject のプロベナンスファイルは最初の zudo-doc eject 時に遅延生成されるため、eject していないプロジェクトはこれを持ちません。

• check:html / HTML バリデーションステップと gen:z-index / check:z-index コードジェネレーションなし — どちらも生成プロジェクトから削除されました。デフォルトの z-index ティアはパッケージから出荷され、HTML バリデーションと pre-push スイートはオプトインの追加項目です（カスタマイズの pre-push / HTML バリデーション復元の節を参照）。

• デプロイアダプターや wrangler.toml なし — デフォルトのビルドは純粋な静的エクスポートです。デプロイ（や AI アシスタントのような SSR 機能の有効化）は明示的な拡張ステップです。

カラースキーム

zudo-doc が同梱するカラースキームは Default Light と Default Dark の 2 つだけで、両者は 1 セットの OKLCH ランプを共有しています。--scheme の値として選べる、コミュニティ製やターミナル由来のプリセットカタログはバンドルされていません。

カスタマイズはもう一段深いレイヤー、zfb.config.ts の colorSchemes エスケープハッチフィールドで行います。独自の { ramps, map } パレットマップを zudoDoc({ colorSchemes: { … } }) に渡します（Color の「カスタムカラースキームの追加」を参照）。ソースにコミットする前に Design Token Panel の Palette タブで結果をライブプレビューできます（カラースキームプレビューを参照）。

テーマパック

カラースキームとは独立に、スキャフォールドは同梱のテーマパック — スキームシステムの上に重なる完成済みデザインバンドル — を起点にしたプロジェクトを生成できます。--theme-pack <slug> を渡すか、対話式の「Theme pack:」プロンプト（カラースキームの質問と機能のマルチセレクトの間に表示されます）で答えます。選んだスラッグは生成される zfb.config.ts の themePack に書き込まれます（デフォルト差分のみ出力する規則に従い、default と異なる場合のみ）。ページ内のスイッチャー UI は独立した機能トグル --theme-pack-switcher です。

オプション

プロジェクト

カラースキーム

テーマパック

機能

プリセット

--preset フラグはセットアッププリセットジェネレーターの JSON 出力を受け付けます。プリセットを読み込むと、すべてのプロンプトがスキップされます（--yes と同様）。個別の CLI フラグはプリセットの値を上書きします。

一般

サポート言語

--lang フラグは以下の言語コードを受け付けます:

デフォルト言語は、ルートページ（/docs/...）で使用されるロケールを決定します。i18n が有効な場合、セカンダリ言語が自動的に追加されます（デフォルトが英語以外の場合は英語、デフォルトが英語の場合は日本語）。

使用例

対話モード

pnpm create zudo-doc

すべてデフォルトで非対話的に実行

pnpm create zudo-doc my-docs --yes

日本語サイト、単一ダークスキーム

pnpm create zudo-doc my-docs --lang ja --scheme "Default Dark" --no-i18n --pm pnpm --install

明示的なデフォルトモードを指定した Light/Dark モード

pnpm create zudo-doc my-docs \
  --color-scheme-mode light-dark \
  --default-mode light \
  --no-respect-system-preference \
  --yes

プリセットファイルの使用

セットアッププリセットジェネレーターで JSON プリセットを生成し、ファイルに保存してから CLI に渡します:

pnpm create zudo-doc --preset setup.json --install

標準入力から JSON を直接パイプすることもできます:

cat setup.json | pnpm create zudo-doc --preset - --install

CI/自動化での使用

pnpm create zudo-doc my-docs \
  --lang en \
  --scheme "Default Dark" \
  --no-i18n \
  --search \
  --no-claude-resources \
  --pm pnpm \
  --install \
  --yes

プログラム API

パッケージはプログラム API もエクスポートしています。オプションオブジェクトは JSON プリセットと同じフィールドに加え、install と git オプションを受け付けます。プログラム API ではどちらもデフォルトで false です:

import { createZudoDoc } from "create-zudo-doc";

await createZudoDoc({
  projectName: "my-docs",
  defaultLang: "en",
  colorSchemeMode: "light-dark",
  lightScheme: "Default Light",
  darkScheme: "Default Dark",
  defaultMode: "dark",
  respectPrefersColorScheme: true,
  themePack: "foundry",
  features: [
    "search",
    "sidebarFilter",
    "sidebarResizer",
    "sidebarToggle",
    "tocToggle",
    "docHistory",
    "footerCopyright",
  ],
  cjkFriendly: false,
  minifyHtml: true,
  headerRightItems: [
    { type: "component", component: "theme-toggle" },
    { type: "component", component: "github-link" },
  ],
  metaTags: {
    description: true,
    ogImage: "/img/ogp.png",
  },
  packageManager: "pnpm",
  install: true,
  git: true,
});

headerRightItems（Header Right Items ガイドを参照）と metaTags（設定を参照）は、同名の JSON プリセットフィールドと同じ形式を受け付け、同じルールで検証されます — 未知の headerRightItems コンポーネント/トリガー名や不正な metaTags サブフィールドの型は、スキャフォールド開始前に例外をスローします。