Skip to main content

evgraph-cli

PyPI License Python

The evgraph command-line tool for Evgraph.

What is it

evgraph-cli gives shell scripts, CI pipelines, and pre-commit hooks the same governance scan the evgraph Python API exposes, without writing any Python. It is intentionally a thin wrapper: this package contains no logic of its own beyond argument parsing and output-format selection — scanning and reporting are entirely delegated to evgraph.scan() / evgraph.scan_dataset_manifest() / Report, so the CLI and the library can never drift in behavior.

Main features

  • evgraph scan MODEL_CARD APPROVAL DEPLOYMENT — runs the Model Card adapter across the three linked artifacts and prints a Report.
  • evgraph scan-dataset-manifest MANIFEST — runs the dataset-manifest adapter over a CSV file and prints a Report.
  • --format {json,markdown,sarif,oscal} — selects how the report is rendered (default json); sarif for CI annotations, markdown for a human-readable review, oscal for compliance tooling.
  • --gate — after printing the report, return exit code 1 when gate evaluation finds evidence expectations not met.
  • --gate --strict — also return exit code 1 when gate evaluation finds inconclusive evidence.

Exit codes

By default, completed scans are report-only: findings are printed and the CLI returns 0, even when the report contains unmet evidence expectations. Use --gate when a shell script or CI pipeline should trip on those findings, and --gate --strict when inconclusive findings should also trip the gate.

  • 0 — the command completed and no requested gate tripped.
  • 1--gate was requested and gate evaluation tripped.
  • 2 — usage, tool, adapter, or input error.

Gate exit codes are automation signals over evidence findings, not legal or regulatory compliance verdicts.

Where to get it

The source is hosted on GitHub at: https://github.com/SVamseekar/evgraph

Binary installers for the latest released version are available at the Python Package Index (PyPI):

pip install evgraph-cli

From source, for contributing:

git clone https://github.com/SVamseekar/evgraph.git
cd evgraph
pip install -e reference/python/evgraph-core
pip install -e reference/python/evgraph-rules
pip install -e reference/python/evgraph
pip install -e reference/python/evgraph-cli

Dependencies

  • evgraph — installed automatically as a dependency, which in turn pulls in evgraph-core and evgraph-rules.

pytest>=7 is required for the test suite (pip install "evgraph-cli[test]").

Quickstart

evgraph scan model_card.json approval.json deployment.json --format markdown
evgraph scan-dataset-manifest dataset_manifest.csv --format json

In a CI pipeline, emitting SARIF lets findings show up as inline annotations in tools that already consume that format:

evgraph scan model_card.json approval.json deployment.json --format sarif > evgraph.sarif

Documentation

For Start here
The Python API this CLI wraps evgraph package README
Output format details (SARIF, OSCAL) docs/specs/
Runnable examples examples/
The full library stack Main project README

Getting help

Ask questions and report bugs via GitHub Issues on the main repository.

Contributing

All contributions, bug reports, and feature requests are welcome on the main repository. See CONTRIBUTING.md and the Code of Conduct. Security reports: SECURITY.md.

License

BSD 3-Clause.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

evgraph_cli-0.1.2.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

evgraph_cli-0.1.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file evgraph_cli-0.1.2.tar.gz.

File metadata

  • Download URL: evgraph_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for evgraph_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 56befc8cb71854da391f3d6dd996768af7d5a9b26ab8d2c4cd61645c9da263b7
MD5 3a6da45d3879e4284f301a89c225140b
BLAKE2b-256 a4eeab6f0687e240f1bd119c3b954844421253211a8918f1ba31c86723435f8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for evgraph_cli-0.1.2.tar.gz:

Publisher: publish.yml on SVamseekar/evgraph

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file evgraph_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: evgraph_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for evgraph_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 326d0f104583f8d81f9c46bab1c9d15c84c4485b1e7a79dd10ec40a86bd4ad44
MD5 c87183e2c5da76be38bf480270b9e929
BLAKE2b-256 b1649fc54fc8a0c8a65da1a4259fd1e5d40126025f2784fdc63dc6e89824f787

See more details on using hashes here.

Provenance

The following attestation bundles were made for evgraph_cli-0.1.2-py3-none-any.whl:

Publisher: publish.yml on SVamseekar/evgraph

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page