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):
- Sign in to PyPI with the team-owned account (2FA enabled).
- Go to Account settings → API tokens → Add API token. Scope it to the
charisma-cliproject once the project exists; for the very first publish use an account-scoped token, then re-scope it to the project afterward. - Copy the token (starts with
pypi-). - In the GitHub Enterprise repo, add it as an Actions secret named
PYPI_API_TOKEN(org-level secret recommended so both packages share it). - Bump
versioninpyproject.tomland 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
| Variable | Required | Description |
|---|---|---|
CHARISMA_ENDPOINT |
Yes | Base URL of the Charisma API |
CHARISMA_TOKEN |
Yes | Service or CI bearer token |
CHARISMA_PROJECT_ID |
Yes | Project alias for result routing |
CHARISMA_RESULTS |
No | Path to allure-results (default: allure-results) |
CHARISMA_RUN_KEY |
No | Run identity / merge key (--run-key fallback) |
BUILD_ID |
No | CI build identifier (--build-id fallback; CHARISMA_BUILD_ID also honored) |
BUILD_PLAN_KEY |
No | Build plan key (--build-plan-key fallback; CHARISMA_BUILD_PLAN_KEY also honored) |
ENVIRONMENT |
No | Environment code (--environment fallback; CHARISMA_ENVIRONMENT also honored) |
COMPONENT |
No | Component alias (--component fallback; CHARISMA_COMPONENT also honored) |
SOURCE_URL |
No | CI/CD build link (--source-url fallback; CHARISMA_SOURCE_URL also honored) |
Flags
Both upload and watch accept the identical option set.
| Flag | Description |
|---|---|
--endpoint URL |
Charisma API endpoint (overrides CHARISMA_ENDPOINT) |
--token TOKEN |
Bearer token (overrides CHARISMA_TOKEN) |
--results PATH |
Allure results directory (overrides env var) |
--project ID |
Project alias (overrides env var) |
--silent |
Don't fail pipeline if upload errors occur |
--skip-too-big |
Skip result files larger than 2MB |
--component ALIAS |
Component alias within the project |
--source-url URL |
CI/CD build link for this run |
--build-plan-key K |
Explicit build plan key for resolution (forwarded as buildPlanKey) |
--build-id ID |
CI build identifier for this run (forwarded as buildId) |
--environment ENV |
Environment code (e.g. qat, prod), stored on the launch |
--run-key KEY |
Run identity / merge key (reruns + parallel workers share it) |
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 }}"
Metadata
Release files for charisma-cli 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| charisma_cli-0.4.0.tar.gz | 66.5 kB | Without provenance | Details for charisma_cli-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| charisma_cli-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for charisma_cli-0.4.0-py3-none-any.whl |
Total release size: 101.9 kB
Release files / charisma_cli-0.4.0.tar.gz
| Download URL | charisma_cli-0.4.0.tar.gz |
|---|---|
| Size | 66.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40f417d507622ce80218294d19d2f9166ee36b1b34622309bea44e50fec75143
|
|
BLAKE2b-256 checksum How to use checksums |
0286ebb1c2690e1fd3a3da3b87174aba7368f62688513298fcc5765b4be383fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.17
|
Release files / charisma_cli-0.4.0-py3-none-any.whl
| Download URL | charisma_cli-0.4.0-py3-none-any.whl |
|---|---|
| Size | 35.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
17f9cd2eb9463b67636d7ae47b17ec4dfc8b3288f747570c3b4dabf23c410015
|
|
BLAKE2b-256 checksum How to use checksums |
74270a36df4b0c09a6449f9df0230c9b84bc835bdaf87bff090d256229e58acc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.17
|
Security for charisma-cli 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.