Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 3.48 KB

File metadata and controls

54 lines (43 loc) · 3.48 KB

warcraft

A monorepo of World of Warcraft data CLIs built for AI agents. The warcraft wrapper routes and composes; each provider binary speaks the same JSON envelope, the same exit codes, and the same global output flags, so an agent can compose guides, reference content, rankings, logs, and local SimulationCraft analysis without learning a new output shape per source. See docs/foundation/PRODUCT_PRINCIPLES.md for what the repo will and will not do.

Install

# release wheel — attached to each GitHub release from the first release after the release workflow lands
pipx install https://github.com/aurokin/warcraft_cli/releases/download/v0.5.0/warcraft-0.5.0-py3-none-any.whl
uvx --from https://github.com/aurokin/warcraft_cli/releases/download/v0.5.0/warcraft-0.5.0-py3-none-any.whl warcraft doctor
# from a checkout (editable)
uv sync --all-extras     # or: make install, or: pip install -e '.[dev,redis]'
make dev-deploy-no-link  # refresh the checkout-local .venv for branch work

Providers

Command Tier Best for Docs
warcraft core routing, discovery, cross-provider composition docs/warcraft
wowhead core entities, guides, comments, talent calc docs/wowhead
warcraftlogs core official log/report analysis (OAuth) docs/warcraftlogs
simc core local SimulationCraft inspection and runs docs/simc
raiderio supported character/guild profiles, Mythic+ analytics docs/raiderio
warcraft-wiki supported reference, lore, API/event articles docs/warcraft-wiki
icy-veins supported guide extraction and local guide query docs/icy-veins
method supported guide extraction and local guide query docs/method
lorrgs supported top-parse cooldown timelines, comp rankings docs/lorrgs
raidbots experimental public report consumption, SimC handoff docs/raidbots
blizzard experimental (verified live for us/eu/kr/tw) Battle.net Game Data and Profile reads docs/blizzard-api
curseforge experimental (verified live) addon metadata and changelogs docs/curseforge

Quick Start

warcraft doctor  # start here when the source is unclear; call a provider binary directly once you know it
warcraft --pretty resolve "thunderfury"
warcraft search "defias"
wowhead entity item 19019

Docs

Development

make check       # lint, typecheck, import boundaries, complexity, dead code, fast tests + coverage floor
make test-e2e    # end-to-end journeys against the real providers (network; docs/architecture/E2E_TESTING.md)
make reference   # regenerate docs/reference/; make skills regenerates provider subskills