Skip to main content

d2w command-line interface (Typer) — mounts plugins from dhis2w-core.

Project description

dhis2w-cli

Typer console script d2w for working with DHIS2 instances from the shell. Discovers plugins from dhis2w-core — sixteen top-level domains covering metadata, data, analytics, tracker, users, routes, files, messaging, apps, doctor, and developer tools.

Install

# Drops `d2w` on $PATH
uv tool install dhis2w-cli

# With Playwright UI automation (browser screenshots, OIDC login, PAT minting)
uv tool install 'dhis2w-cli[browser]'
playwright install chromium    # one-time, after the install above

# Update later
uv tool upgrade dhis2w-cli

Or run on demand without installing:

uvx --from dhis2w-cli d2w --help

Configure

The CLI reads a profile from .dhis2/profiles.toml (project) or ~/.config/dhis2/profiles.toml (user). One-shot bootstrap:

d2w profile bootstrap mywork

Or set env vars and skip the profile system entirely:

export DHIS2_URL=https://dhis2.example.org
export DHIS2_PAT=d2p_...
d2w system info

Surface

d2w analytics    DHIS2 analytics queries.
d2w apps         DHIS2 apps — /api/apps + /api/appHub.
d2w browser      Playwright UI automation (only with [browser] extra).
d2w data         DHIS2 data values (aggregate + tracker).
d2w dev          Developer/operator tools.
d2w doctor       Probe a DHIS2 instance for known gotchas + requirements.
d2w files        Manage DHIS2 documents + file resources.
d2w maintenance  DHIS2 maintenance (tasks, cache, integrity, cleanup, refresh).
d2w messaging    DHIS2 internal messaging.
d2w metadata     DHIS2 metadata inspection.
d2w profile      Manage DHIS2 profiles.
d2w route        DHIS2 integration routes.
d2w system       DHIS2 system info.
d2w user         DHIS2 user administration.
d2w user-group   DHIS2 user-group administration.
d2w user-role    DHIS2 user-role administration.

d2w --help for the full tree; d2w <group> --help for each.

Documentation

Full CLI reference: https://winterop-com.github.io/dhis2w-utils/cli-reference/.

dhis2w-cli is one member of the dhis2w-utils workspace. The MCP server (dhis2w-mcp) exposes the same plugin surface as MCP tools.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dhis2w_cli-0.22.0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dhis2w_cli-0.22.0-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file dhis2w_cli-0.22.0.tar.gz.

File metadata

  • Download URL: dhis2w_cli-0.22.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dhis2w_cli-0.22.0.tar.gz
Algorithm Hash digest
SHA256 05138e2ab11e7429fbe558dfb1d6a566ef4ba418cce14520129e116e6e0edc47
MD5 c96e1f5d1238a68d83ada998ec65838a
BLAKE2b-256 d3630c99d98653c5775d6ee3acfdc29b4eb8ceeec33943e4b80cf171bf8fb1d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhis2w_cli-0.22.0.tar.gz:

Publisher: pypi-publish.yml on winterop-com/dhis2w-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dhis2w_cli-0.22.0-py3-none-any.whl.

File metadata

  • Download URL: dhis2w_cli-0.22.0-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dhis2w_cli-0.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b61bba70f18120742f95cb659a765cb560f39100b348a40268d22c1c7e6b58b
MD5 745fb892ddaa704079cb37c5f2f02821
BLAKE2b-256 4a36dd89a082803ef4a0f3c970d96f21815b0b19ab16e84b8874ebd5e884fb44

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhis2w_cli-0.22.0-py3-none-any.whl:

Publisher: pypi-publish.yml on winterop-com/dhis2w-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page