Skip to main content

Sync and search Azure DevOps work items and wiki pages for AI agents

Project description

ado-search

Sync and search Azure DevOps work items and wiki pages locally for AI agents.

Install

pip install ado-search

Or from source:

pip install git+https://github.com/HurleySk/ado-search.git

Quick Start

# Configure (requires az login first)
ado-search init --org https://dev.azure.com/yourorg --project YourProject

# Pull data
ado-search sync

# Search
ado-search search "login bug"
ado-search search "auth" --type Bug --state Active
ado-search search "setup guide" --format paths

How It Works

  1. Sync pulls work items and wiki pages from Azure DevOps
    • Tries OData analytics first (fetches all items in one call — fast)
    • Falls back to az devops CLI if analytics isn't available
  2. Content is stored as compact markdown files (one per item)
  3. Metadata is indexed in SQLite with FTS5 for fast full-text search
  4. Agents search the index, then read only the files they need — minimal context

Commands

Command Description
ado-search init Configure organization, project, and auth
ado-search sync Pull latest data from Azure DevOps
ado-search search "query" Full-text search with filters
ado-search show <id> Display full content of an item

Auth Methods

  • az-cli (default): Uses az devops commands. Requires az login.
  • az-powershell: Uses Azure PowerShell + REST. Requires Connect-AzAccount.
  • pat: Uses a Personal Access Token via REST. For cross-cloud or service account scenarios.

Set via ado-search init --auth-method <method> or in config.toml.

# PAT example (token can also be set via ADO_PAT env var)
ado-search init --org https://dev.azure.com/yourorg --project YourProject --auth-method pat --pat <token>

Search Formats

ado-search search "query"                          # compact (default)
ado-search search "query" --format detail           # with description snippets
ado-search search "query" --format json             # machine-readable
ado-search search "query" --format paths            # file paths only (for agent piping)
ado-search search "query" --type Bug --state Active # filtered

Prerequisites

  • Python 3.10+
  • Azure CLI with azure-devops extension (az extension add --name azure-devops)
  • az login completed

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

ado_search-0.5.0.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

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

ado_search-0.5.0-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

Details for the file ado_search-0.5.0.tar.gz.

File metadata

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

File hashes

Hashes for ado_search-0.5.0.tar.gz
Algorithm Hash digest
SHA256 ef2747e1cf444c386c3deed993b40ca51ee5a5ff1fdf7f961ac037bafe789ccd
MD5 3cad99ed9cd5f66780c13e08f7370a0a
BLAKE2b-256 115489f29a950a0c80ba662a69cbbe09e5a6eab41feff680603569a9fc0bb5e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ado_search-0.5.0.tar.gz:

Publisher: publish.yml on HurleySk/ado-search

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

File details

Details for the file ado_search-0.5.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for ado_search-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d43529e5a8ccda689394cf1e3477de2b8a3958173df83b275333d57b48110c0
MD5 7eccb510c03278b1853607289546fb74
BLAKE2b-256 666ec5fd63fe38b942255fabaa55054d94b1acaa152921be1bb007dca7fa19f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ado_search-0.5.0-py3-none-any.whl:

Publisher: publish.yml on HurleySk/ado-search

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