OpsDash CLI

Command-line client for the OpsDash API — login, list apps, update/deploy, migrate, PM2 actions.

npm: opsdash

Install

npm install -g opsdash
opsdash --version

Quick start

opsdash login --userName admin --password admin123
opsdash config get
opsdash apps
opsdash update 55 --type api --path ./backend

Saved credentials (after login) live in:

• Windows: %USERPROFILE%\.opsdash\config.json
• Linux/macOS: ~/.opsdash/config.json

Fields: baseUrl, userName, password, token, paths.

opsdash login                          # reuse saved user/password
opsdash config set baseUrl http://10.10.10.181:22307
opsdash config set path 55 C:\path\to\backend

Commands

| Command | Purpose | |---------|---------| | opsdash login | Authenticate; store token + credentials | | opsdash logout | Clear token + credentials | | opsdash whoami | Show current user / baseUrl | | opsdash config get | Print config (password redacted) | | opsdash config set baseUrl <url> | API URL | | opsdash config set path <appId> <dir> | Cache local project path | | opsdash apps | List apps | | opsdash apps status <id> | PM2 / app status | | opsdash apps logs <id> [--error] | Tail logs | | opsdash apps action <id> restart | PM2 restart/stop/… | | opsdash update <appId> | Build locally, ZIP, upload, update | | opsdash migrate <appId> | Prisma migrate on server | | opsdash upload <zip> | Upload archive only | | opsdash deploy new | Register / first deploy flow | | opsdash deployments | List / get / watch / cancel | | opsdash servers | List / test servers |

Update flags

opsdash update <appId> --type api|frontend [--path <dir>] [--skip-build] [--migrate] [--no-watch]

For AI agents / Cursor

1. Prefer opsdash over raw curl for OpsDash deploys.
2. Ensure global install: npm i -g opsdash.
3. Login once per machine; config persists under ~/.opsdash/.
4. Confirm appId before update / migrate / PM2 actions.
5. Server 10.10.10.181 has no outbound internet — build locally; do not rely on remote npm install.
6. Do not zip node_modules or .next/dev by default.
7. If a command is missing, extend this CLI rather than one-off scripts.

Short agent pointer: AGENTS.md

Default API

http://10.10.10.181:22307 — change with opsdash config set baseUrl ….

Develop this package

cd cli
npm install
npm run link:local    # or: npm run build && npm link
npm version patch && npm publish --access public

License

MIT