schiplat/super repository overview

⁠Project Super

The API-First, Lightweight Process Orchestrator for the Edge.

Super is a modern replacement for tools like Supervisor⁠ or PM2⁠, built with Rust. It is designed for edge computing, IoT devices, and high-performance servers.

⁠Core Features

• Single binary — Rust superd process manager; TOML or REST config; CLI and HTTP API (Dashboard via optional ui plugin)
• Declarative orchestration — stacks, dependencies, health checks
• Lifecycle hooks — pre_start, post_start, post_stop, and global event hooks
• Observability — WebSocket logs, historical logs API, system metrics
• Auto-recovery — Supervisor-compatible autorestart, exitcodes, startsecs

Licensed under the MIT License⁠. Optional licensed plugins (.so / .dylib under $SUPER_ROOT/plugins/) add API auth, RBAC, notifications (storm suppression⁠), and cgroup limits — same superd binary, no separate commercial build. Compare editions in the feature matrix⁠.

⁠Quick Start

⁠Install script (Linux / macOS / FreeBSD)

curl -fsSL https://github.com/schiplat/super/releases/latest/download/install.sh | sh

Installs superd and super, creates a minimal instance root (/opt/super or ~/.super), and enables an OS service (systemd on Linux, launchd on macOS, rc.d on FreeBSD) with boot start. Verifies the SHA-256 of the release archive.

Options: --version, --prefix, --root, --user / --system, --no-service, --no-start, --no-init, --no-sudo.

Bleeding-edge (may differ from the latest tagged binaries): curl -fsSL https://raw.githubusercontent.com/schiplat/super/master/install.sh | sh.

⁠Docker

Docker image (linux/amd64, linux/arm64). This is the supported path on Windows (Docker Desktop or WSL2) — there is no native superd.exe release. The OSS image has no API authentication — bind to loopback on the host unless you add the security plugin and a license:

docker pull schiplat/super:latest
docker run --rm -p 127.0.0.1:9002:9002 schiplat/super:latest

With a custom config directory:

docker run --rm -p 127.0.0.1:9002:9002 -v ./packaging/docker/conf:/app/super/conf schiplat/super:latest

⁠From source

Requires Rust 1.85+ (stable):

git clone https://github.com/schiplat/super.git && cd super
make build
./target/release/superd              # foreground (default; use under systemd/Docker)
# ./target/release/superd --daemon   # optional Unix self-daemonize without systemd

⁠CLI

super add --name redis --autostart /usr/bin/redis-server
super list
super logs <id> --tail
super shutdown                       # stop superd (foreground or --daemon)

Diagnose a setup (config, daemon connectivity, license, daemon/pidfile hints) in one shot:

super doctor

See Installation⁠ for install.sh (systemd / launchd / rc.d), manual units (superd --foreground), and optional --daemon.

⁠Toward GA

We will call Super production-ready (GA) when the following are true. If you rely on Super today, this is the contract we are working against — feedback on any of these is the most valuable contribution right now.

• Stability — no known panic paths in the daemon on malformed config or API input; graceful degradation when a plugin fails.
• Upgrade safety — OTA updates are transactional (backup → verify → commit/rollback) and covered by integration tests.
• Security defaults — fail-closed network binding, signed-plugin verification, and no secrets in API/CLI output; cargo audit clean on release branches.
• Operability — super doctor diagnoses a deployment end-to-end; logs and metrics are sufficient to triage without a debugger.
• API stability — the REST API and the plugin C ABI (PLUGIN_API_VERSION) are versioned; breaking changes ship only with a major bump and migration notes.

Track progress in the changelog⁠.

⁠Documentation

⁠AI skills

Want your AI assistant (Cursor, Claude, Copilot, …) to configure and troubleshoot Super correctly? Point it at docs/SKILL.md⁠ (e.g. from CLAUDE.md, .cursor/rules, or pasted into the prompt). It covers everyday commands, the super.toml / stack JSON schema, cron & health semantics, and common failure modes — and helps avoid the usual supervisor/PM2 semantic mix-ups.

⁠Repository layout

⁠Contributing

See CONTRIBUTING.md⁠. Security issues: SECURITY.md⁠. Community standards: CODE_OF_CONDUCT.md⁠.