Getting Started

Installation

Homebrew (macOS/Linux)

brew install rundops/tap/dops

Go

go install github.com/rundops/dops@latest

Docker

docker pull ghcr.io/rundops/dops:latest

From Source

git clone https://github.com/rundops/dops.git
cd dops
make install

---

Initialize

dops init

This creates ~/.dops/ with a default configuration and a sample hello-world runbook.

---

Launch the TUI

dops

Navigate with arrow keys, press Enter to run a runbook, fill in parameters, and confirm.

---

Launch the Web UI

dops open

Opens a browser-based interface at http://localhost:3000 with the same catalog, forms, and execution streaming. See the Web UI guide for details.

---

Add Your First Catalog

A catalog is a directory of runbooks. Create one:

mkdir -p ~/.dops/catalogs/my-team/hello-world

Create the runbook definition:

# ~/.dops/catalogs/my-team/hello-world/runbook.yaml
name: hello-world
version: 1.0.0
description: Say hello
risk_level: low
script: script.sh
parameters:
  - name: greeting
    type: string
    required: true
    description: The greeting message
    scope: runbook

Create the script:

#!/bin/sh
set -eu

GREETING="${GREETING:?greeting is required}"

main() {
  echo "==> Stage 1/1: Hello"
  echo "    ${GREETING}"
  echo ""
  echo "Done"
}

main "$@"

Make it executable:

chmod +x ~/.dops/catalogs/my-team/hello-world/script.sh

Register the catalog:

dops catalog add ~/.dops/catalogs/my-team

Launch dops — your runbook will appear in the sidebar.

---

Install a Shared Catalog

Install a catalog from a git repository:

dops catalog install https://github.com/your-org/ops-runbooks.git

Update it later:

dops catalog update ops-runbooks

---

Run a Runbook from the CLI

Execute a runbook non-interactively:

dops run my-team.hello-world --param greeting="Hello, world!"

---

Environment

Variable	Default	Description
DOPS_HOME	~/.dops	Config and catalog directory
DOPS_NO_ALT_SCREEN	(unset)	Set to 1 to disable alternate screen