Documentation
CLI Reference
All commands grouped by category. Run oxmgr --help or oxmgr <command> --help for inline help.
Runtime & Monitoring
| Command | Description |
|---|---|
| oxmgr list | Show all processes with status, CPU, RAM, uptime |
| oxmgr status <name> | Detailed process info including restart policy, limits, log paths |
| oxmgr logs <name> [-f] [--lines <n>] | Stream or show logs. oxmgr logs all prints recent logs for every process. |
| oxmgr ui [--interval-ms <n>] | Interactive terminal UI with keyboard + mouse |
| oxmgr runtime <config> [--env <profile>] [--only a,b] | Foreground/container mode — no daemon, runs processes and forwards logs to stdout/stderr |
Lifecycle
| Command | Description |
|---|---|
| oxmgr start "<cmd>" --name <n> | Start a process. See start options below. |
| oxmgr stop <name|config> | Stop a running process. stop all stops every managed process. |
| oxmgr restart <name|config> | Restart a process (resets crash-loop counter). restart all restarts all. |
| oxmgr reload <name> | Graceful reload (zero-downtime where supported) |
| oxmgr pull [name] | Git pull + reload/restart only if commit changed. Without target pulls all git-tracked. |
| oxmgr delete <name|config> | Stop and remove from daemon state. delete all removes all. |
Start Options
All flags supported by oxmgr start. These correspond directly to oxfile.toml fields.
| Flag | Default | Description |
|---|---|---|
| --name <n> | Process name used in CLI commands | |
| --restart <policy> | on-failure | always | on-failure | never |
| --max-restarts <n> | 10 | Max consecutive auto-restarts |
| --crash-restart-limit <n> | 3 | Stop restarting after N crashes in 5 min. 0 = disabled |
| --cwd <path> | Working directory for the process | |
| --env KEY=VALUE | Environment variable (repeatable) | |
| --watch | false | Watch cwd and restart on file changes |
| --watch-path <path> | Explicit path to watch (repeatable). Requires --watch. | |
| --ignore-watch <regex> | Ignore paths matching regex during watch scans (repeatable). | |
| --watch-delay <s> | 0 | Restart debounce after file-watch change. Requires --watch. |
| --health-cmd <cmd> | Command polled to verify health | |
| --health-interval <s> | 30 | Seconds between health checks |
| --health-timeout <s> | 5 | Timeout for each health check |
| --health-max-failures <n> | 3 | Failures before restart |
| --wait-ready | false | Gate start/reload on health check readiness. Requires --health-cmd. |
| --ready-timeout <s> | 30 | Timeout for readiness check. Requires --wait-ready. |
| --kill-signal <signal> | SIGTERM | Signal sent to process on stop/reload. |
| --stop-timeout <s> | 5 | Grace period before force-kill |
| --restart-delay <s> | 0 | Delay between auto-restarts |
| --start-delay <s> | 0 | Delay before initial process start |
| --cluster | false | Node.js cluster mode |
| --cluster-instances <n> | all CPUs | Worker count (requires --cluster) |
| --namespace <name> | Group process under a namespace | |
| --max-memory-mb <n> | Memory limit in MB | |
| --max-cpu-percent <n> | CPU usage limit (%) | |
| --cgroup-enforce | false | Apply hard limits via Linux cgroup v2 at spawn time |
| --deny-gpu | false | Best-effort GPU disable via env vars |
| --pre-reload-cmd <cmd> | Command run before reload. Reload aborts if this fails. | |
| --reuse-port | false | Best-effort SO_REUSEPORT hint (macOS/Linux only) |
| --log-date-format <fmt> | Prefix each log line with a timestamp (e.g. "%Y-%m-%d %H:%M:%S") | |
| --cron-restart <expr> | 6-field cron expression for scheduled restarts (e.g. "0 0 2 * * *" = daily at 2 AM) |
Config Commands
| oxmgr apply <path> [--env <profile>] [--only a,b] [--prune] | Apply oxfile config. --prune removes unmanaged processes. |
| oxmgr validate <path> [--env <profile>] | Validate oxfile before deploy. Great for CI. |
| oxmgr import <source> [--sha256 <hex>] | Import oxpkg bundle or ecosystem.config.json |
| oxmgr export <name> | Export process config as oxpkg bundle |
| oxmgr convert <ecosystem.json> --out <oxfile.toml> | Convert PM2 ecosystem JSON to oxfile.toml |
Deploy Commands
PM2-style remote deployment. Requires a [deploy.<env>] block in your oxfile.toml.
| oxmgr deploy <config> <env> setup | Initial server setup for a deploy environment. |
| oxmgr deploy <config> <env> update [--force] | Deploy latest commit to remote. |
| oxmgr deploy <config> <env> revert [n] | Roll back N releases (default 1). |
| oxmgr deploy <config> <env> current | Show current deployed release. |
| oxmgr deploy <config> <env> list | List all releases on remote. |
| oxmgr deploy <config> <env> exec "<cmd>" | Run a command in the current release directory. |
Service & Daemon
| oxmgr doctor | Check daemon health, IPC reachability, filesystem layout, cgroup prerequisites, and more. |
| oxmgr startup [--system <auto|systemd|launchd|task-scheduler>] | Enable daemon autostart on boot (convenience shorthand). |
| oxmgr service install [--system <...>] | Install daemon as a system service. |
| oxmgr service status [--system <...>] | Show system service status. |
| oxmgr service uninstall [--system <...>] | Remove system service registration. |
| oxmgr daemon run | Start the Oxmgr daemon process. |
| oxmgr daemon stop | Stop the running daemon. |
--system auto resolves to systemd on Linux, launchd on macOS, and task-scheduler on Windows.
See System Services.
Interactive UI — Keyboard Shortcuts
Launch the TUI with oxmgr ui. Mouse supported — click to select, scroll to navigate.
| Key | Action |
|---|---|
| j / k or ↑↓ | Move selection up / down |
| n | Create new process |
| s | Stop selected |
| r | Restart selected |
| l | Reload selected |
| p | Pull selected (git pull + reload) |
| t | Preview latest log line |
| g / Space | Refresh now |
| ? | Show help overlay |
| Esc | Open / close menu |
| q | Quit |
Still have questions?
Open an issue or browse the source on GitHub.