Documentation

Quick Start

Get from zero to running processes in under two minutes.

1 — Install

npm install -g oxmgr

More install methods: Homebrew, APT, Chocolatey, Scoop, AUR, source

2 — Write your oxfile.toml

oxfile.toml

version = 1

[defaults]
restart_policy = "on_failure"
max_restarts = 10
stop_timeout_secs = 5

[[apps]]
name = "api"
command = "node server.js"
cwd = "./services/api"
health_cmd = "curl -fsS http://127.0.0.1:3000/health"

[apps.env]
NODE_ENV = "production"
PORT = "3000"

[[apps]]
name = "worker"
command = "python worker.py"
cwd = "./services/worker"

[apps.env]
PYTHONUNBUFFERED = "1"

Full reference: oxfile.toml configuration

3 — Apply

oxmgr apply ./oxfile.toml

apply is idempotent — safe to run in CI/CD. Starts new processes, restarts changed ones, leaves untouched ones alone.

4 — Monitor

oxmgr list           # show all processes
oxmgr logs api -f    # stream logs
oxmgr ui             # interactive terminal UI

Full CLI reference: CLI Reference

Installation →

All install methods: npm, Homebrew, APT, Chocolatey, AUR, source

CLI Reference →

All commands, flags, and keyboard shortcuts

oxfile.toml →

Full field reference, profiles, clustering, file watch

Health Checks →

Command-based health checks and readiness gating

Resource Limits →

Memory, CPU limits, and cgroup enforcement

System Services →

Install Oxmgr as a system service on any platform

Git & Webhooks →

Auto-deploy on push with git integration and webhooks

PM2 Migration →

Import and convert your existing PM2 ecosystem config

Environment Variables →

OXMGR_* variables for daemon configuration

Still have questions?

Open an issue or browse the source on GitHub.

Open an Issue ↗