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.23.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.23.0-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dhis2w_cli-0.23.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.23.0.tar.gz
Algorithm Hash digest
SHA256 f7404056900953a1120be4eff2aa26ee64d01e2f5847ea68a12e2eceb228b76b
MD5 90bd13d1ea23bf42eb5c7de684fa876c
BLAKE2b-256 c403766322376e5e7c8b05bd593cca252e17b53a1bb3570b492b2a8f47c87559

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhis2w_cli-0.23.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.23.0-py3-none-any.whl.

File metadata

  • Download URL: dhis2w_cli-0.23.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.23.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecb8e25fda9901bd0312e80dfc0ccfd7ab34bc7543d6079fcf52db7f81c574e1
MD5 f84d716f0f05f7adbf71aaaced2ea3c4
BLAKE2b-256 19fe66e9aa1d7b0417f0c2a297d4935526cf9a7ab4c84739b4132505e011249b

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhis2w_cli-0.23.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