Cassis CLI — run Cassis actions (ontology validation) from your CI pipelines
Project description
Cassis CLI
Run Cassis actions from your CI pipelines. The first command, cassis ontology check, validates the ontology files in your repository with the exact same checks as the Cassis GitHub PR check (YAML parsing, round-trip, import validation) — so you can gate merges in any CI system, not just GitHub.
Install
pip install cassis-cli
Setup
- Create an API key in Cassis under Organization settings → API keys (keys start with
sk-k6-). - Store it as a CI secret and expose it as
CASSIS_API_KEY.
Usage
# From the root of a repository synced with Cassis (contains the ontology export directory, cassis/ by default):
cassis ontology check
# Or point at the checkout explicitly:
cassis ontology check /path/to/checkout
# Machine-readable output:
cassis ontology check --json
Configuration (flags take precedence over env vars):
| Flag | Env var | Default |
|---|---|---|
--api-key |
CASSIS_API_KEY |
— (required) |
--api-url |
CASSIS_API_URL |
https://app.getcassis.com |
--base-path |
CASSIS_BASE_PATH |
cassis — must match the project's git-sync "Path" setting |
Exit codes
| Code | Meaning |
|---|---|
| 0 | Ontology is valid |
| 1 | Validation failed (findings printed) |
| 2 | Usage error (missing API key, no ontology directory, unreadable file, tree over the size limits) |
| 3 | Transport/API error (unreachable API, invalid key, unexpected response) |
The check accepts up to 2000 YAML files / 5 MB total — far above real
ontologies (a few hundred small files). Beyond that the CLI fails fast with
exit 2 before uploading anything; double-check --base-path if you hit it.
GitHub Actions example
jobs:
ontology-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- run: pip install cassis-cli
- run: cassis ontology check
env:
CASSIS_API_KEY: ${{ secrets.CASSIS_API_KEY }}
GitLab CI example
ontology-check:
image: python:3.12-slim
script:
- pip install cassis-cli
- cassis ontology check
variables:
CASSIS_API_KEY: $CASSIS_API_KEY
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cassis_cli-0.1.0.tar.gz.
File metadata
- Download URL: cassis_cli-0.1.0.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.2 CPython/3.14.3 Darwin/25.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
530e3fc74d443fca3b72ee20d9859f5f31fb480850fa6dd7d651b8c81c4c76ef
|
|
| MD5 |
9ad24bb7d5c3b2d5fc4a5973c5884192
|
|
| BLAKE2b-256 |
26fbfbbce4186dfb65ee37bd96c28bfcf23c2f71c90160ecc1d2fe606b9a5cab
|
File details
Details for the file cassis_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: cassis_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.2 CPython/3.14.3 Darwin/25.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f4c5a120f00b244ea6025bf788eb927d7ae7dec61a4dec8a1522ad362632301b
|
|
| MD5 |
c5e03f1a132ffe26556b83993b59885c
|
|
| BLAKE2b-256 |
9fb3d95a6c2add44333a3291648e3a0ce5305658fd12329cf0dbe3e3d810bb57
|