Repository navigation
Ruby Implementation
This page is about wip v1, which was a Ruby gem. From v2,
wipships as a self-contained C# Native AOT binary (wip.exe) — no Ruby, no runtime to install. See Getting Started for the current install path.The Ruby implementation has no further updates planned. It still works and remains available, frozen, at v1.1.4 and as the
wslc-wipgem on RubyGems — but bug fixes, new features, and WSLC compatibility updates only land in the C# implementation from here on. Its source has also been removed from the main branch of the repository (recoverable from git history).
gem install wslc-wipRequires Ruby 3.2+. The gem is named wslc-wip; the command it installs is wip.
The v1 Ruby internals are kept on their own pages, unchanged, for anyone still running or referencing v1:
- Architecture — how the v1 Ruby codebase was laid out
- Development — v1 dev setup, tests, and contributing
- Testing and Linting — v1's RSpec/RuboCop suite
- Release Process — how a v1 gem release was cut
Everything else in this wiki — modes, wip.yml keys, commands, guides, troubleshooting —
describes user-facing behavior that applies to both v1 and v2 unless a page says otherwise. Only
wip's own implementation language and install method changed at v2.
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 help
- wip manual
- 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
- AI-Assisted Initialization
- 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
Ruby Implementation (legacy)