Skip to main content

​
Orphelix CLI

The Orphelix CLI provides a convenient way to manage your Kubernetes dashboard as a background service using pm2. It handles installation, configuration, and lifecycle management with simple commands.

​
Key Features

  • 🚀 One-Command Setup - Auto-installs dependencies, builds, and configures on first run
  • 🔄 Background Execution - Runs as a daemon via pm2, no need to keep terminal open
  • 🌐 Custom Hostname - Configures orphelix.local for easier access
  • 💾 SQLite Database - Persistent storage for settings and preferences
  • 🔔 Desktop Notifications - Get alerts for critical Kubernetes issues
  • 📦 Multi-Instance Support - Run multiple instances for different clusters
  • 🔄 Auto-Update - Update to latest version from GitHub with automatic backup
  • 💾 Backup & Restore - Easy database backup and restore functionality
  • 🚀 Auto-Startup - Optional system boot auto-start

​
Quick Start

# Install globally via npm
git clone https://github.com/corapoid/orphelix.git && cd orphelix/app

# Start Orphelix (first run will auto-install and configure)
orphelix start

# Open in browser
orphelix open

# View logs
orphelix logs

# Stop the application
orphelix stop

​
First Run Setup

On first run, orphelix start will automatically:
  1. ✅ Check and install npm dependencies
  2. ✅ Build standalone Next.js application
  3. ✅ Configure orphelix.local hostname (requires sudo)
  4. ✅ Initialize SQLite database
  5. ✅ Start application in background via pm2
  6. ✅ Start notification worker for desktop alerts
You’ll be prompted once for sudo password to configure /etc/hosts.

​
Access URLs

After starting, access Orphelix at:
  • Custom hostname: http://orphelix.local:3000
  • Standard localhost: http://localhost:3000

​
Architecture

┌─────────────────────────────────────────────────────┐
│              Orphelix CLI (orphelix)                │
│                                                      │
│  Commands: start, stop, restart, logs, status, etc. │
└─────────────────────┬───────────────────────────────┘
                      │
                      ▼
┌─────────────────────────────────────────────────────┐
│                  PM2 Process Manager                 │
│                                                      │
│  ┌──────────────────┐    ┌───────────────────────┐ │
│  │  orphelix        │    │ orphelix-notifications│ │
│  │  (main app)      │    │ (worker)              │ │
│  │  Port: 3000      │    │                       │ │
│  └──────────────────┘    └───────────────────────┘ │
└─────────────────────┬───────────────────────────────┘
                      │
                      ▼
┌─────────────────────────────────────────────────────┐
│               orphelix.db (SQLite)                   │
│                                                      │
│  - User settings                                     │
│  - GitHub configuration                              │
│  - Cluster aliases                                   │
│  - Notification preferences                          │
└──────────────────────────────────────────────────────┘

​
Command Categories

​
Process Management

Start, stop, restart, and monitor the application
  • start - Start Orphelix in background
  • stop - Stop Orphelix
  • restart - Restart Orphelix
  • status - Check if running
  • logs - View real-time logs
  • list - List all running instances
  • delete - Remove from pm2

​
Information

Get information about the application
  • version - Show version and check for updates
  • info - Show detailed application info
  • doctor - Run health checks

​
Backup & Configuration

Manage data and settings

​
Development

Tools for developers
  • dev - Start in development mode
  • debug - Start with debugger
  • test - Run tests
  • clean - Clean caches and logs

​
Maintenance

System maintenance and updates

​
Global Options

These options work with multiple commands:
  • --port, -p - Specify custom port (default: 3000)
  • --name, -n - Instance name for multi-instance support

​
Environment Variables

  • ORPHELIX_PORT - Set default port (can be overridden with --port)

​
Next Steps

Installation

Install Orphelix CLI globally

Commands

Explore all available commands

Multi-Instance

Run multiple instances for different clusters

Troubleshooting

Common issues and solutions