witr Documentation

Why is this running? Trace any process, port, container, or file back to what started it - CLI + TUI.

22,728 stars Go Go 29 files ยท ~54,590 tokens #cli#containers#devops#docker#freebsd#go#golang#incident-response
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy witr on any server, homelab, or cloud container platform.

witr

A single static-binary CLI (Linux, macOS, Windows, FreeBSD) that answers "why is this running?" by tracing any process, port, container, or open file back to the exact causal chain that started it โ€” supervisors, containers, services, shells โ€” as a human-readable tree, JSON, or an interactive TUI.

Getting Started

  • Purpose: what problem witr solves and how it differs from ps, top, lsof, ss, systemctl, docker ps.
  • Installation: quick-install script, package managers (Homebrew, APT, Conda, MacPorts, etc.), and manual/source install.
  • Interactive tutorial: browser-based guided tour and free-play sandbox, no install required.

Reference

  • Flags & Options: full CLI flag reference (--pid, --port, --file, --container, --json, --tree, --short, --exact, --verbose, --warnings, etc.), all repeatable and combinable.
  • Core Concept: how witr maps ports/services/containers/commands to PIDs and builds the causal chain.
  • Example Outputs: name-based, short, tree, container, file, and multi-target query examples.
  • Output Behavior: output principles, exit codes (0-6), and standard output sections.
  • JSON Output: the --json contract: stable field names and types, every output shape, and failures as {Target, Error}.
  • Using witr with AI Coding Agents: a snippet for agent instruction files and the official skill.
  • Interactive Mode (TUI): key features of the dashboard mode.

Optional

  • Agent skill: how an AI agent should use witr: which command fits, reading the JSON and exit codes, and asking before stopping anything.
  • Platform Support: feature compatibility matrix and permissions notes across OSes.
  • License: Apache License 2.0.