// General instructions for using the community-domo-cli in this repository, including install/auth setup, endpoint testing, and troubleshooting.
| name | community-cli-howto |
| description | General instructions for using the community-domo-cli in this repository, including install/auth setup, endpoint testing, and troubleshooting. |
Run and troubleshoot community-domo-cli commands in this repository with the current locked endpoint surface.
Recommended for users:
pipx install "git+https://github.com/stahura/community-domo-cli.git"
community-domo-cli --help
Contributor/testing path:
python3 -m pip install -e .
community-domo-cli --help
# alternate module invocation for local dev
python3 -m community_domo_cli --help
Prereq — install the Domo CLI and log in once:
npm install -g ryuu
domo login -i modocorp.domo.com
Then set env vars before running commands:
export DOMO_INSTANCE=modocorp
export DOMO_AUTH_MODE=ryuu-session
community-domo-cli datasets list
Token auth is deprecated.
auth_mode=tokenis no longer supported bycommunity-domo-cli. If you see "Token auth mode is no longer supported", rundomo login -i <instance>again and keepDOMO_AUTH_MODE=ryuu-session.
~/.config/configstore/ryuu/<instance>.jsondomo loginhttps://<instance>.domo.com/api (the CLI already handles /api).raw passthrough command exists.--dry-run first for mutating operations when validating payloads.datasets listdatasets schema <dataset_id>datasets sql <dataset_id> --body/--body-fileappdb collectionsappdb collection-get <collection_id>appdb document-create <collection_id> --body/--body-filecode-engine get-package <package_id>code-engine create-package --body/--body-filecode-engine update-version <package_id> <version> --body/--body-fileworkflows get <workflow_id>filesets get <fileset_id>filesets file-get <fileset_id> <file_id>filesets upload <fileset_id> --body/--body-filefilesets download <fileset_id> <file_id> --output <path>community-domo-cli ...python3 -m community_domo_cli ... is mainly for local contributor testingpython3 community_domo_cli ...DOMO_INSTANCE and DOMO_AUTH_MODE=ryuu-session are setdomo login has been run successfully for the target instancedatasets listappdb collections--dry-run before real execution.Step-by-step orchestrator for building Domo App Studio apps with native KPI cards via community-domo-cli. Sequences app creation, pages, theme, hero metrics, native charts, filter cards, layout assembly, and navigation. CLI-first — no raw API calls.
Domo KPI card CRUD via community-domo-cli — body schema, column mapping, beast modes, chart type index with on-demand reference files, and gotchas.
**Generating sample data for Domo** -- invoke when a user needs to create realistic sample datasets and upload them to a Domo instance. Primary signals: requests for sample data, demo data, test data, fake data for Domo; mentions of Salesforce, Google Analytics, QuickBooks, NetSuite, Google Ads, Facebook Ads, HubSpot, Marketo, or Health Portal sample data; questions about the datagen CLI or domo_data_generator. Covers: generating datasets, uploading to Domo, creating datasets in Domo, rolling dates, entity pools, connector icons, catalog management, and adding new dataset definitions. Skip for: real connector setup, production data pipelines, data transformations (Magic ETL), or Domo App Platform.
Create AppDB collections via CLI-first workflows where collection creation also provisions the required datastore, then returns collection identifiers for manifest wiring and document-write follow-up. Use when an agent must initialize new AppDB storage for a Domo app, not just list/get collections or create documents.
Create Domo Code Engine packages from CLI workflows with deterministic payload contracts, automatic function parameter datatype mapping, and manifest packagesMapping follow-up guidance. Use when an agent must create a new package/versioned package container rather than only invoke an existing function from app runtime code.
Update Domo Code Engine packages through CLI-driven versioned lifecycle workflows with compatibility checks, datatype contract safeguards, and manifest mapping drift synchronization. Use when an agent must update package code or create a new package version and keep app mappings aligned.