Configuration Reference

Configuration Reference

wip.yml の全キーを網羅するリファレンス。README の Configuration 節を、Kubernetes/Docker Compose の公式リファレンスのように「項目→意味→デフォルト値→注意点」の形式で再構成する。

Outline

wip.yml 共通

• version: / mode: の役割
• 設定ファイルの探索ルール（サブディレクトリからの実行、--config PATH）
• wslc: ブロック（command: auto の探索順）

Container Mode

• container: （プライマリコンテナの指定、dependencies: がある場合は必須）
• network:
• dependencies: の各エントリ（image, command, env, ports, volumes, workdir, restart）
• プライマリ vs サイドカーの操作上の違い（up/down/exec/run/build/interaction: の対象範囲）
• interaction:（commands: エイリアス、両方定義時の ConfigError）
  • type: exec / type: run / type: build
  • built-in コマンド名との衝突（wip dispatch NAME での回避）
• restart: と wip up --watch の関係
  • 対応値（no/always/unless-stopped/on-failure[:MAX_RETRIES]）
  • ポーリング方式であることの制約（event-basedではない、on-failureの終了コード判定はしない）

Compose Mode

• compose: ブロック（service, command, file, project）
• dependencies:/network: との排他関係
• サードパーティ compose-for-wslc ツールの立ち位置（wip は勝者を選ばない）
• 対応コマンドの範囲（up/down/exec/logs、runはexecへのフォールバック、type: run/build非対応）

Compose Mode (Native)

• compose: ブロック（service, file, project）との違い（command:なし、container:なし）
• サポートする compose.yml サブセット一覧
  • サービスレベル: image, build, command, environment, ports/volumes（short syntax限定）, working_dir, user, restart, depends_on（service_startedのみ）
  • 無視されるキー: tty, stdin_open, networks
  • トップレベルで無視されるセクション: networks:, volumes:, configs:, secrets:
  • 未対応キーを書いた場合の ConfigError の挙動
• wip logs の単一サービス制限

Dependencies & Networking（横断トピック）

• primary/sidecar の設計思想を図解
• ネットワーク作成タイミング（wip up 時に無ければ作成）

.env

• 読み込みルール（KEY=VALUE、コメント、export、クォート）
• 優先順位（env: が .env より優先）
• --env-file PATH

.dockerignore & Build Context

• wip build が .dockerignore を尊重する仕組み
• shadow_context によるビルドコンテキスト最適化（WSL2限定、/mnt/<drive>では無効）

Source Sync (sync:)

• 全パラメータ一覧（source, target, volume, mount, exclude, delete, command, options, interval, mode, image, build）
• sync.mode: exec vs run の使い分けとイメージ要件の違い
• モード別デフォルトの違い（container/compose-native vs compose）
• wip init --template ごとの exclude デフォルト一覧表
• ボリュームによるマウント書き換えルール
• sync.build の挙動（wip up/wip sync ごとに1回ビルド、--watchループ開始前に1回）
• 注意点（一方向同期であること、delete: false の使いどころ）