-
-
Notifications
You must be signed in to change notification settings - Fork 1
Getting Started
Yusuke Abe edited this page Aug 10, 2026
·
3 revisions
README の Requirements & installation / Quick start を、初見のユーザー向けにもう少し丁寧に展開したページ。
- 前提条件
- Ruby 3.2+ / WSL2 / Microsoft WSLC
-
wslc自体のインストール確認 (wslc.exe/wslc/ System32 の探索順)
- インストール
gem install wslc-wip- ソースからのインストール(
bundle install && bundle exec exe/wip version) - バージョン確認 (
wip version)
- 最初の一歩
-
wip initでwip.ymlを生成(--template rails|node|rust|csharpの使い分け) -
compose.ymlがある場合は自動でcompose-nativeが選ばれる、という挙動の説明 - 生成された
wip.ymlの TODO を埋める
-
- 動作確認
-
wip doctorで診断(何がOK/WARN/FAILになるか一覧) -
wip build→wip up -d→wip <interaction名>の一連の流れ
-
- 次に読むべきページへの導線
- どのモードを使うか迷ったら → Concepts
-
wip.ymlの全項目を知りたい → Configuration Reference - 起動が遅い場合 → Guides#起動が遅い場合の対処
Introduction
Modes
Configuration
- Configuration Reference
- Config File Discovery
- Dependencies
- Networking
- Interactions
- Restart Policies
- Env Files
- Secret Masking
- Dockerignore
- Shadow Build Context
- Source Sync
- Sync Modes
compose.yml support
- Compose File Support
- Compose Build
- Compose Depends On
- Compose Profiles
- Compose Variable Interpolation
Commands
- CLI Command Reference
- wip init
- wip version
- wip doctor
- wip config
- wip build
- wip up
- wip stop
- wip down
- wip exec
- wip run
- wip shell
- wip logs
- wip sync
- wip dispatch
- Global Options
- Debug Output
- TTY Allocation
Guides
- Guides
- Migrating from dip
- Reusing an Existing compose.yml
- Fixing a Slow Boot
- Continuous Sync
- Auto Restarting Containers
- Multi Arch Images
- Using wip in CI
Troubleshooting
- Troubleshooting & FAQ
- FAQ
- Configuration Errors
- WSLC Not Found
- Registry Authentication
- Architecture Mismatch
- Volume Limit Reached
- rsync Not Found
- Reporting Issues
Comparison
Project