Skip to content

README.md

Latest commit

 

History

History
177 lines (136 loc) · 6.68 KB

README.md

File metadata and controls

177 lines (136 loc) · 6.68 KB
Raw

RunDock — Developer Project Console

RunDock icon

A polished local project and process manager for Windows (and cross-platform). RunDock keeps related services together and exposes logs and ports when needed.

License: MIT Built with Rust Platform: Windows GitHub

Installation

Manual installer

Download the latest RunDock-x.x.x-windows-x64-setup.exe from Releases and run it. The installer adds the RunDock command-line tools to your PATH automatically. The installer adds the rundock.exe desktop app. It opens the local dashboard in its own window, starts the daemon when needed, stays available in the system tray, and enables current-user login startup by default. Closing the window hides it to the tray; Exit RunDock closes only the desktop app and leaves the daemon and managed projects running.

Debian / Ubuntu (signed APT repository)

Download the public key, inspect its fingerprint against the key attached to the matching GitHub Release, then install it:

curl -fsSL https://damingishere-coder.github.io/RunDock/gpg-key.asc -o rundock-release-key.asc
gpg --show-keys --fingerprint rundock-release-key.asc
sudo gpg --dearmor --yes -o /usr/share/keyrings/rundock-archive-keyring.gpg rundock-release-key.asc
echo "deb [signed-by=/usr/share/keyrings/rundock-archive-keyring.gpg] https://damingishere-coder.github.io/RunDock/apt stable main" | sudo tee /etc/apt/sources.list.d/rundock.list
sudo apt update
sudo apt install alter

The packaged service is opt-in: sudo systemctl enable --now alter-daemon.service. System mode uses /var/lib/alter-pm2 and /var/log/alter-pm2; it is isolated from per-user data.

Features

  • No console window popups — processes run silently in the background (Windows)
  • Auto-restart with exponential backoff on crash
  • Watch mode — restart automatically on file changes
  • Namespaces — group and bulk-control related processes
  • Web dashboard — real-time process monitor at http://localhost:2999/
  • Live log streaming — tail logs in terminal or browser
  • State persistence — save and restore your process list across reboots
  • Ecosystem config — define all apps in one TOML or JSON file
  • Full REST API — automate everything
  • Self-contained Windows installer — desktop app plus the compatible CLI/daemon
  • Dashboard authentication — password-protect the web UI with Argon2id hashing, session tokens, and a PIN quick-unlock
  • Telegram bot — control your processes from Telegram: list, start, stop, restart, tail logs, and receive crash/restart alerts
  • AI assistant — multi-provider chat panel (Ollama, GitHub Models, Claude, OpenAI-compatible) with streaming responses and process-aware context
  • Port Finder — scan all open TCP/UDP ports, see owning processes, and kill by PID from the dashboard
  • Notifications — Slack, Discord, Microsoft Teams, and webhook alerts on crash, restart, cron events, and more
  • Process enable/disable — exclude individual processes from Start All without removing them
  • Terminal history — per-process command history persisted across sessions
  • Sidebar namespace groups — active processes grouped by namespace with collapsible sections and bulk stop/restart

Build from source

Requires Rust 1.98, Node.js 24, and npm. The dashboard must be built before Rust embeds web-ui/dist into the binary.

git clone https://github.com/damingishere-coder/RunDock
cd RunDock
cd web-ui
npm ci
npm run build
cd ..
cargo build --release --locked
# Binary: target\release\alter.exe
cargo build --manifest-path desktop-shell\Cargo.toml --release --locked
# Desktop app: desktop-shell\target\release\rundock.exe

Quick Start

# Start the daemon
alter daemon start

# Start processes
alter start python -- -m http.server 8080
alter start node --name api -- server.js
alter start go --name backend --cwd C:\projects\api -- run main.go

# List processes
alter list

# Stream logs
alter logs api --follow

# Open web dashboard
alter web    # → http://127.0.0.1:2999/

Windows

RunDock is built with Windows as a first-class platform:

  • Spawned processes use CREATE_NO_WINDOW — no black console popups
  • Daemon runs completely hidden in the background
  • rundock.exe provides a single-instance WebView2 window and system tray
  • Login startup is enabled by default with --background and can be toggled from the tray
  • Closing or exiting the desktop app never stops managed projects
  • npm, yarn, npx and other .cmd scripts work directly
  • Terminal button opens Windows Terminal or cmd.exe in the process directory
  • Data stored in %APPDATA%\alter-pm2\

If the desktop window cannot reach the daemon, its local failure page offers Retry, Open log directory, Copy diagnostics, and Open in browser. An occupied or incompatible port 2999 is reported without ending that listener. If WebView2 is unavailable, repair the RunDock installation or install the Microsoft Edge WebView2 Evergreen Runtime; the installer normally deploys it automatically after verifying Microsoft's signature.

Ecosystem Config

# alter.config.toml
[[apps]]
name      = "api"
script    = "python"
args      = ["-m", "uvicorn", "main:app", "--port", "8000"]
cwd       = "C:\\projects\\api"
namespace = "web"
[apps.env]
PORT = "8000"

[[apps]]
name      = "worker"
script    = "node"
args      = ["dist/worker.js"]
watch     = true
namespace = "workers"
[apps.env]
NODE_ENV = "production"
alter start alter.config.toml

Documentation

Full documentation is in docs/:

Document Description
README Full project overview and setup guide
CLI Reference All commands, flags, and examples
API Reference Full REST API documentation
Ecosystem Config Config file format reference
Architecture How RunDock works under the hood
Changelog Version history

License

MIT — see LICENSE for details.