domo-scripts

CLI toolkit for automating and managing Domo business intelligence instances. Bulk operations on DataFlows, DataSets, Streams, PDP policies, content sharing, and more — all through a single entry point.

Install

This package is not published to the npm registry. Install it directly from GitHub.

As a dependency in another project

npm install github:brycewc/domo-scripts            # latest main
npm install github:brycewc/domo-scripts#v1.0.0     # pinned to a release tag

or in your package.json:

"dependencies": {
  "domo-scripts": "github:brycewc/domo-scripts#v1.0.0"
}

There is no build step, so a plain npm install (or yarn add) is all that's needed.

Then create a .env in your project's root (the directory you run commands from) with your Domo credentials:

DOMO_INSTANCE=your-instance
DOMO_ACCESS_TOKEN=your-access-token

The instance name is the subdomain from your Domo URL (https://<instance>.domo.com). Config (.env / .env.<name>), logs/, and id-mappings/ all resolve against your project's working directory, not the installed package. You can also supply DOMO_INSTANCE / DOMO_ACCESS_TOKEN as real environment variables (e.g. in CI) with no .env file at all.

Use the CLI — the package installs a domo-scripts bin:

npx domo-scripts --help
npx domo-scripts bulk-share-content --file content.csv --user 12345 --content-type card

Use it as a library — require('domo-scripts') returns the shared modules:

const { api, readCSV, resolveIds, createLogger, config } = require('domo-scripts');

For local development on this repo

git clone https://github.com/brycewc/domo-scripts.git
cd domo-scripts
yarn install
cp .env.example .env

Edit .env with your Domo credentials (same variables as above), then run commands with node cli.js <command>.

Multiple Environments

To target more than one Domo instance, create a per-environment file alongside .env:

.env.prod        # DOMO_INSTANCE=acme-prod, DOMO_ACCESS_TOKEN=...
.env.sandbox     # DOMO_INSTANCE=acme-sandbox, DOMO_ACCESS_TOKEN=...

Select one at runtime with --env <name>:

node cli.js --env prod bulk-rename-datasets --file ds.csv
node cli.js --env sandbox bulk-rename-datasets --file ds.csv --dry-run

.env.* files are git-ignored. A bare .env is still loaded as a fallback for any shared defaults.

Transferring Between Instances

Migration commands (e.g. transfer-stream) operate on two instances at once. Pass both env names:

node cli.js transfer-stream --source-env prod --target-env sandbox --stream-id 12345
node cli.js transfer-stream --source-env prod --target-env sandbox --file streams.csv --dry-run

Each transfer records old→new IDs in id-mappings/<source>_to_<target>.json (also git-ignored), so multiple instance pairs can coexist (prod_to_sandbox.json, prod_to_dev.json, etc.). Some kinds — accounts, users, providers — must be pre-populated by hand before transferring assets that reference them; commands abort with a clear error if a required mapping is missing.

Usage

node cli.js [--env <name>] <command> [options]
node cli.js --help                    # List all commands
node cli.js <command> --help          # Command-specific options

Quick Examples

# Update stream schedules to once daily between 6 AM and 8 PM
node cli.js bulk-update-stream-schedules --file "streams.csv" --start-hour 6 --end-hour 20

# Add trigger conditions to dataflows from a CSV
node cli.js bulk-add-dataflow-trigger-condition --file "dataflows.csv" --column "DataFlow ID"

# Or pass a single ID for debug logging
node cli.js bulk-add-dataflow-trigger-condition --id 123

# Upload data to a dataset in batches
node cli.js upload-dataset --file "data.csv" --dataset-id "abc-123" --batch-size 50000

# Share content with a user
node cli.js bulk-share-content --file "content.csv" --user "12345" --content-type "card"

# Preview destructive changes with dry run
node cli.js bulk-delete-content --file "datasets.csv" --object-types "dataset" --id-column "DataSet ID" --dry-run

# Filter CSV input before processing
node cli.js bulk-update-stream-schedules --file "streams.csv" --filter-column "status" --filter-value "ACTIVE"

Commands

Command	Description
build-activity-log-type-map	Build a map of activity-log object types to their available event types (actions), written to a dated JSON file
bulk-add-dataflow-tags	Add tags to dataflows from a CSV or by owner
bulk-add-dataflow-trigger-condition	Add DATAFLOW_LAST_RUN trigger conditions to dataflow triggers
bulk-add-dataset-tags	Add tags to datasets from a CSV or by owner
bulk-apply-pdp-policies	Copy PDP policies from a source dataset to target datasets
bulk-convert-stream-provider	Convert streams from one connector type to another
bulk-delete-content	Delete mixed content (dataflows, cards, datasets, groups, pages, alerts, app-studio apps, custom apps, Jupyter workspaces, AI projects, workflows, projects, project tasks, AppDB collections, accounts) from a CSV, routing each row to the right endpoint by type — consumes the bulk-list-user-content CSV directly; --delete-output-datasets also deletes each dataflow's output datasets
bulk-delete-dataflow-triggers	Remove all triggers from dataflows listed in a CSV
bulk-delete-users	Delete users listed in a CSV. Does not check or transfer ownership — prompts for confirmation.
bulk-export-dataset-versions	Export historical versions of a dataset
bulk-list-user-content	List everything a set of users own (datasets, cards, pages, etc.) into a single CSV — one row per (user, object)
bulk-rename-dataflows	Find/replace in dataflow names across the instance
bulk-rename-datasets	Find/replace in dataset names across the instance
bulk-revoke-access-tokens	Revoke developer access tokens by ID, CSV, owner, expiration, or deleted owner
bulk-unshare-content	Unshare content in bulk
bulk-share-content	Share content (cards, datasets, pages, dataflows) with users/groups
bulk-transfer-ownership	Transfer ownership of a user's content (datasets, cards, pages, etc.) to a new owner, either all discovered from the user or from a CSV
bulk-update-column-pdp-policy	Update users/groups on a column-based PDP policy
bulk-update-stream-schedules	Change stream schedules to daily (randomized times), manual, or restore arbitrary schedules from a CSV (--mode from-file)
bulk-update-stream-update-method	Change stream update mode from Replace to Append
bulk-update-users	Bulk update user attributes from a CSV via PATCH (one row per user)
check-credentials	Validate the configured API credentials against the selected instance
clear-logs	Delete every log file under logs/ (supports --dry-run and --command filter)
delete-unused-beast-modes	Find and bulk-delete beast modes with no active links (not used in any card or view), optionally filtered by owner, dataset, or creation date; variables excluded unless --include-variables
extract-card-ids	Extract card IDs from a page export JSON
run-workflow-from-csv	Convert a CSV to workflow input format and run a Domo workflow
swap-input-in-dataflows	Replace a dataset input across all consuming dataflows
transfer-stream	Copy a stream (and its input dataset) from one instance to another
upload-dataset	Upload CSV data to a dataset in configurable batches

Common Options

Most bulk commands that process a list of IDs support these options:

Option	Description
--file, -f	Path to a CSV file containing IDs
--column, -c	CSV column name to extract IDs from
--<entity>-id	Single ID (enables detailed debug logging)
--<entity>-ids	Comma-separated IDs
--filter-column	Filter CSV rows: column name to match
--filter-value	Filter CSV rows: required value
--dry-run	Preview changes without applying them

Project Structure

domo-scripts/
├── cli.js              # Entry point — dispatches to commands
├── lib/
│   ├── index.js        # Re-exports all shared modules
│   ├── config.js       # Environment config and auth
│   ├── api.js          # Authenticated Domo API client (get/put/post/del)
│   ├── csv.js          # CSV parsing with optional filtering
│   ├── input.js        # Resolve IDs from CSV/flags
│   └── log.js          # Debug and run log utilities
├── commands/           # One file per command (29 total)
├── logs/               # Generated run/debug logs (git-ignored)
├── .env                # Your credentials (git-ignored)
├── .env.<name>         # Per-environment credentials, selected with --env (git-ignored)
├── .env.example        # Template for .env
└── id-mappings/        # Per-env-pair old→new ID mappings, written by transfer commands (git-ignored)

Adding a New Command

1. Create commands/your-command.js
2. Import shared libs: const { api, resolveIds, createLogger } = require('../lib');
3. Add --help handling before any API calls
4. Register it in the commands map in cli.js

Logging

Commands that support logging write JSON files to logs/<commandName>/:

• Run logs (run_<timestamp>.json) — summary of all items processed in a bulk run
• Debug logs (debug_<itemId>_<timestamp>.json) — detailed per-item logs when using --<entity>Id
• Dry-run variants are prefixed with dry_