Skip to content
costhelm

Installation

costhelm is a single Python package (≥3.11). The server, the client, the CLI and the packaged default configs all ship in the wheel.

Run without installing

Section titled “Run without installing”
Terminal window
uvx costhelm serve

Install into a project

Section titled “Install into a project”
Terminal window
uv add costhelm        # or: pip install costhelm
costhelm serve

From source

Section titled “From source”
Terminal window
git clone https://github.com/gadekar-pravin/costhelm
cd costhelm
uv sync
uv run costhelm serve

Run the test suite (no provider keys needed — live-API tests are marked and skipped):

Terminal window
uv run pytest -m "not requires_live_api and not requires_models"

As a service

Section titled “As a service”

The repo’s deploy/ directory has templates for systemd (Linux), launchd (macOS) and Windows services, plus a Modal wrapper for a one-command cloud deployment. See Deployment.

State on disk

Section titled “State on disk”

Everything lives under ~/.costhelm/ by default: the priced ledger (gateway.sqlite) and any config overrides. costhelm paths prints exactly what resolved where. Override the directory with COSTHELM_CONFIG_DIR, or just the ledger with COSTHELM_GATEWAY_DB.