charisma-cli

CLI tool that watches an allure-results directory during test execution and streams results + attachments to the Charisma ingestion API in real time.

Installation

pip install charisma-cli

No token, no index URL — works on any laptop and in any CI. The package is published to public PyPI; the Charisma repo itself stays private (only this client wheel is public).

For local development from a checkout of the repo:

pip install -e packages/charisma-cli

Publishing (maintainers)

Releases publish to public PyPI automatically from the merge-queue workflow using a PyPI API token.

Trusted publishing (OIDC) is not used because this repo runs on GitHub Enterprise Server, whose OIDC issuer PyPI does not trust. A stored API token is required instead.

One-time setup (done once by a PyPI project owner):

1. Sign in to PyPI with the team-owned account (2FA enabled).
2. Go to Account settings → API tokens → Add API token. Scope it to the charisma-cli project once the project exists; for the very first publish use an account-scoped token, then re-scope it to the project afterward.
3. Copy the token (starts with pypi-).
4. In the GitHub Enterprise repo, add it as an Actions secret named PYPI_API_TOKEN (org-level secret recommended so both packages share it).
5. Bump version in pyproject.toml and merge — the workflow builds and publishes on the next release.

Rotate the token periodically and store it in the team secret manager.

Usage

export CHARISMA_ENDPOINT=https://charisma.company.com
export CHARISMA_TOKEN=<your-service-token>
export CHARISMA_PROJECT_ID=my-project

charismactl watch --results allure-results -- uv run pytest -n 4 tests/

Environment Variables

Flags

Launch URL in CI

charismactl prints the Charisma launch URL (Charisma launch: <url>) and, when running in GitHub Actions, writes it as a step output named launch_url. Attach it to the job summary or a Teams message:

- name: Run tests and stream to Charisma
  id: charisma
  run: charismactl watch --project my-project -- pytest tests/

- name: Add Charisma link to summary
  if: always()
  run: echo "[View Charisma launch](${{ steps.charisma.outputs.launch_url }})" >> "$GITHUB_STEP_SUMMARY"

# The same value can feed a Teams-notification step:
#   text: "Results: ${{ steps.charisma.outputs.launch_url }}"