CLI Reference
All commands available in the devpanel CLI.
npm install -g devpanel-clidevpanel install[--dir <path>] [--port <number>]Download Docker images, write docker-compose.yml and .env, then start all services. Auto-generates secrets. Registers an auto-start task so DevPanel restarts on reboot.
| Flag / Arg | Description |
|---|---|
| --dir <path> | Installation directory (default: ~/.devpanel on macOS/Linux, %APPDATA%\devpanel on Windows) |
| --port <number> | Dashboard port (default: 33000) |
devpanel uninstall[--yes] [--keep-data]Stop and remove all DevPanel containers, remove the auto-start task, and delete the installation directory.
| Flag / Arg | Description |
|---|---|
| --yes | Skip confirmation prompt |
| --keep-data | Remove containers but keep the installation directory and data volumes |
devpanel startStart all DevPanel services (runs docker compose up -d). Prints dashboard and API URLs on success.
devpanel stopStop all DevPanel services (runs docker compose down).
devpanel restartRestart all DevPanel services (runs docker compose up -d).
devpanel updatePull the latest Docker images, rewrite docker-compose.yml to the latest version, and restart services. The API runs database migrations automatically on boot.
devpanel statusShow the status of all DevPanel containers (alias for docker compose ps).
devpanel psShow containers and live resource usage (CPU, memory, network I/O) in a combined table.
devpanel logs[service] [-f] [--tail <n>]Stream logs from all services, or a specific one. Follows by default.
| Flag / Arg | Description |
|---|---|
| service | Optional service name: api, worker, web, agent, postgres, redis |
| -f / --follow | Follow log output (default: true) |
| --tail <n> | Number of lines to show from the end (e.g. --tail 100) |
devpanel backup[--output <file>]Dump the PostgreSQL database to a .sql file using pg_dump.
| Flag / Arg | Description |
|---|---|
| --output <file> | Output file path (default: devpanel-backup-<date>.sql in the current directory) |
devpanel restore<file> [--yes]Restore the PostgreSQL database from a .sql backup file. Overwrites the current database.
| Flag / Arg | Description |
|---|---|
| <file> | Path to the .sql backup file (required) |
| --yes | Skip confirmation prompt |
devpanel env[--edit]Print the current .env configuration (sensitive values masked by default).
| Flag / Arg | Description |
|---|---|
| --edit | Open .env in $EDITOR for direct editing |
devpanel exec<service>Open an interactive shell (bash or sh) inside a running DevPanel container.
| Flag / Arg | Description |
|---|---|
| <service> | One of: api, worker, web, agent, postgres, redis |
devpanel reset[--yes]Permanently wipe all data (database, volumes) and restart DevPanel from scratch. Irreversible.
| Flag / Arg | Description |
|---|---|
| --yes | Skip confirmation prompt |
devpanel reset-admin-passInteractively reset the password for an admin account. Prompts for email and new password.
devpanel versionPrint the CLI version and show the currently running Docker image tags.
Quick examples
# Install to a custom directory on port 8080
devpanel install --dir /opt/devpanel --port 8080
# Tail API logs only
devpanel logs api --tail 200
# Backup database
devpanel backup --output ~/backups/devpanel-$(date +%Y%m%d).sql
# Restore from backup (skip confirmation)
devpanel restore ~/backups/devpanel-20240101.sql --yes
# Open a postgres shell
devpanel exec postgres