Skip to main content

Azure DevOps work item fetcher for agentic coding tools

Project description

azwi

azwi fetches Azure DevOps work item context for agentic coding tools such as Codex CLI and Claude Code.

The tool is designed for deterministic, machine-friendly Markdown or JSON output with clean stdout on success and stderr-only logging.

Install and run

Local checkout:

uv run ./azwi.py --help
uv run ./azwi.py 2195 --org my-org

Packaged command:

uvx azwi --help
azwi 2195 --org my-org

Authentication

azwi reads an Azure DevOps PAT from:

  • AZWI_PAT

Required PAT scopes:

  • Work Items: Read
  • Code: Read

The PAT is not stored in ~/.azwi/config.toml.

Primary usage

azwi <work_item_id> [--org ORG] [--section SECTION ...] [--format {markdown,json}]

Examples:

azwi 2195
azwi 2195 --section acceptance
azwi 2195 --section metadata --section comments --comment-limit 20
azwi 2195 --format markdown
azwi 2195 --output wi-2195.md
azwi 2195 --output wi-2195.md --download-images assets
azwi 2195 --field-acceptance Custom.Acceptance
azwi 2195 --extra-field Custom.DevNotes
azwi fields --type Bug --project Payments
azwi config show

Commands

Fetch a work item:

azwi <work_item_id> [options]

List fields for a work item type:

azwi fields --type Bug [--project PROJECT] [--org ORG]

Manage config:

azwi config show
azwi config set-defaults --org my-org --project Payments
azwi config set-field --global --acceptance Microsoft.VSTS.Common.AcceptanceCriteria
azwi config set-field --project Payments --description Custom.DevDescription
azwi config add-extra-field --project Payments Custom.ReleaseNotes

Output

Default sections:

  • metadata
  • description
  • acceptance
  • comments
  • prs

Formats:

  • json
  • markdown

Default format:

  • json

JSON includes stable top-level work_item metadata plus a sections object containing rendered Markdown text and source field reference names for text fields. Markdown remains available as an explicit render mode for prompt-friendly output.

Configuration

azwi uses ~/.azwi/config.toml for non-secret defaults and field mappings.

Supported config layers:

  • top-level defaults
  • top-level project overrides
  • org-specific defaults
  • org-specific project overrides
  • per-invocation CLI overrides

Example:

[defaults]
org = "my-org"
project = "ProjectA"

[defaults.fields]
description = "System.Description"
acceptance = "Microsoft.VSTS.Common.AcceptanceCriteria"
repro_steps = "Microsoft.VSTS.TCM.ReproSteps"
system_info = "Microsoft.VSTS.TCM.SystemInfo"

[projects."ProjectB".fields]
acceptance = "Custom.AcceptanceNotes"
extra_fields = ["Custom.ReleaseNotes"]

[orgs."other-org".defaults]
project = "ProjectX"

[orgs."other-org".defaults.fields]
acceptance = "Custom.Acceptance"

azwi config show renders the effective resolved config. PATs are never written to the config file.

Image download behavior

Use --download-images DIR together with --output to download remote Markdown image URLs and rewrite them to local relative paths.

Relative DIR paths resolve from the current working directory, not from the output file location.

Packaging and publishing

This repo supports both:

  • uv run ./azwi.py ... via the PEP 723 metadata block in the root wrapper
  • uvx azwi ... via the package defined in pyproject.toml

Build:

uv build --no-sources

Release workflow:

  • tag a release such as v0.9.2
  • GitHub Actions builds the package
  • publish to PyPI using Trusted Publishing

License

MIT

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

azwi-0.9.2.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

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

azwi-0.9.2-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file azwi-0.9.2.tar.gz.

File metadata

  • Download URL: azwi-0.9.2.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for azwi-0.9.2.tar.gz
Algorithm Hash digest
SHA256 1a7046164bff246774c02e7a79c303499197d6739a5ef43d0fdb645088abf14b
MD5 76bbb1e8d5cdeb22be24874a0bec0c62
BLAKE2b-256 ae503aed893df3834f60d6bfe80794b1d12720c1804cfbb5e58e28f81c764488

See more details on using hashes here.

File details

Details for the file azwi-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: azwi-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for azwi-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 410e3d8673338b43a8747d5dcb2a633c93332204dc60cba34527b73aebf916a0
MD5 f859afdcd41788f429ecdbec5964b69d
BLAKE2b-256 b1bf28c66986dcd9fc7a861143535327c4137a0ac0fa92f08b575b67576f56b2

See more details on using hashes here.

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