CLI

install 済み binary は project script、pnpm exec oxiquill、npx oxiquill から実行します。project 作成には pnpm dlx oxiquill も使えます。

Global option

Option	動作
--help, -h	global または command-specific usage を表示し、成功で終了します。
--version	install 済み Oxiquill package version を表示します。
--debug	error の cause/stack を表示します。通常の expected error は簡潔です。
--config <path>	すべての project command で指定 Astro/Oxiquill config を使います。
--	残りの対応 argument を underlying Astro command へ渡します。

unknown option、option value の欠落、unknown command、余分な positional argument は usage を表示して non-zero で終了し、project を変更しません。

Command

Command	動作
init [directory]	versioned static starter を作ります。default は current directory です。
dev	必要な runtime を生成し、watcher と Astro development server を起動します。
dev:runtime	runtime/source watcher だけを起動します。
dev:astro	Astro development server だけを起動します。
build	必要な runtime を生成し、check 後に static site を作ります。
preview	既存 production build を preview します。
check	必要な runtime、Astro type を同期し、Astro diagnostics を実行します。
docgen	manifest を同期し、--wasm dev | build で必要な runtime も build します。
clean	resolved Oxiquill-owned/generated path と設定済み Astro output だけを削除し、verified download cache は保持します。
test-rust	optional helper crate を test します。
test-rust-coverage	helper crate を 85% coverage threshold 付きで test します。
lint-rust	helper crate の全 target に warning deny で Clippy を実行します。
doc-rust	dependency を除いて helper crate documentation を build します。
test-wasm	runtime を生成し、すべての generated Rust/Haskell cell を default input で実行します。

dev:runtime は source change の監視を始める前に、runtime を一度初回同期します。runtime が生成済みの場合は oxiquill dev:runtime --skip-initial を使います。この option は起動時に同期せず watcher を登録し、最初の関連 docs/crate event を待ちます。統合された dev command は明示的な起動時生成を一度だけ行い、内部でこの mode を使います。

dev、dev:astro、build、preview、check は documented Astro argument を受け取り、-- より後の値もそのまま渡します。

pnpm dev -- --host 0.0.0.0 --port 4321
pnpm check -- --minimumSeverity warning

安全な project 作成

pnpm dlx oxiquill init my-docs
cd my-docs
pnpm install
pnpm check
pnpm build
pnpm preview

init が受け入れるのは存在しない target または既存の空 directory だけです。non-empty target を上書きせず、dependency install や Git init を行わず、force option もありません。npm package name は lowercase で安全な形に変換され、無効または空の basename は oxiquill-docs になります。作成失敗時は可能な限り partial output を除去し、recovery または次の手順を正確に表示します。

Runtime/tool failure

strict command は必要な compiler、generated artifact、config、download dependency がないと失敗します。該当する場合、diagnostic は command/tool、page、fence line、cell ID、field/path を示します。dev は Haskell compiler/build failure を許容して docs server を維持しますが、再生成に成功するまで該当 cell に error を表示します。

復旧方法は トラブルシューティング を参照してください。