@icedq/cli
v0.1.3
Published
CLI for iceDQ rule and workflow promotion across environments
Maintainers
Readme
@icedq/cli
CLI for iceDQ rule and workflow promotion across environments.
Wraps the iceDQ import/export REST APIs to handle authentication, async job polling, multipart bundle uploads, and import log parsing in a single command.
Install
npm install -g @icedq/cliRequires Node.js 18 or newer.
Authenticate
Set the following environment variables (or pass equivalent flags):
| Variable | Description |
|---|---|
| ICEDQ_URL | iceDQ instance base URL, e.g. https://app.icedq.com |
| ICEDQ_KEYCLOAK_URL | Keycloak token endpoint base, e.g. https://auth.icedq.com/auth/realms/icedq |
| ICEDQ_CLIENT_ID | OAuth client ID (client_credentials grant) |
| ICEDQ_CLIENT_SECRET | OAuth client secret |
| ICEDQ_ORG_ID | iceDQ organization ID |
| ICEDQ_ACCOUNT_ID | iceDQ account ID |
| ICEDQ_WORKSPACE_ID | Source/target workspace ID |
Commands (v0.1)
icedq export
Initiates an export, polls until complete, downloads the bundle.
icedq export --resource workflow --id wkfl-... --output-file ./finance.zip
icedq export --resource folder --id fldr-... --include-child --output-file ./finance.zipicedq import
Submits a bundle, polls until complete, parses the log.
icedq import \
--bundle ./finance.zip \
--kind workflows \
--mapping-file ./mapping.json \
--strict \
--retain-log ./icedq-import.logA hand-authored mapping.json is required in v0.1. Auto-mapping by name (generate-mapping) ships in v0.2.
GitHub Actions
For CI/CD usage via GitHub Actions, see the Using the iceDQ GitHub Actions guide. It covers prerequisites (Keycloak client_credentials setup, GitHub secrets/environments), quick-start examples, a full Dev → QA → UAT → Prod promotion pipeline, mapping file authoring, self-hosted runners, troubleshooting, and FAQ.
Companion repos:
Roadmap
- v0.2 —
icedq generate-mapping,icedq jobs,icedq published,icedq validate - v0.2 — companion GitHub Actions:
icedq/export-action,icedq/validate-action
The build specification is the source of truth for behavior.
