Skip to content

CLI Command Reference

Yusuke Abe edited this page Aug 10, 2026 · 3 revisions

CLI Command Reference

Expands README's Commands table into one section per command — --help-level detail plus examples and links to the relevant config.

Outline

  • Command table (reproduced from README, each row linking to an anchor on this page)
  • wip init [--force] [--template NAME]
  • wip version
  • wip doctor (the individual checks are detailed on Troubleshooting, linked from here)
  • wip config (masked key patterns: token/password/secret/credential/auth)
  • wip build [--no-cache] [-- OPTIONS]
  • wip up [-d] [--no-sync] [--no-cache] [--watch] [--interval N]
    • --watch in detail (poll interval, why -d becomes implicit, which modes don't support it)
  • wip stop vs. wip down (stop only vs. stop-and-remove)
  • wip exec [--no-interactive] COMMAND...
  • wip run [--no-interactive] COMMAND... (the exec fallback behavior under compose mode)
  • wip shell
  • wip logs [-f] [SERVICE...] (compose modes only; compose-native caps at one service)
  • wip sync [-w] [--interval N]
  • wip NAME ARGS... (running interaction: entries; name collisions with built-ins resolved via wip dispatch NAME)
  • TTY allocation rules (how config, the CLI flag, and real-TTY detection combine)
  • Debugging options
    • --debug / WIP_DEBUG=1 sample output
    • Resource snapshots (load average, memory, disk I/O, top CPU consumers)
    • --debug-log=- vs. --debug-log=PATH
    • Reading "looks stuck but CPU/IO is low" as bind-mount stat/open overhead

Clone this wiki locally