Skip to main content

keyhole-cli

CLI for interacting with Keyhole-compatible runtimes.

Install

pip install keyhole-cli

Verify installation:

keyhole --help

Quick Example

Start the test runtime:

docker compose up

Run commands:

keyhole runtime health
keyhole runtime identity
keyhole runtime state
keyhole runtime realize sha256:abc123

Replay the same digest:

keyhole runtime realize sha256:abc123

The runtime returns ALREADY_REALIZED.

Commands

keyhole runtime health

Checks runtime liveness.

keyhole runtime health
# Equivalent to: GET /healthz

keyhole runtime identity

Returns runtime identity and capabilities.

keyhole runtime identity
# Equivalent to: GET /identity

keyhole runtime state

Displays the current runtime state.

keyhole runtime state
# Equivalent to: GET /state

keyhole runtime realize

Submits a realization request using a candidate digest.

keyhole runtime realize sha256:abc123
# Equivalent to: POST /realize {"candidate_digest": "sha256:abc123", "payload": {}}

Options:

  • --payload-json '{"key": "value"}' — inline JSON payload
  • --payload-file path/to/payload.json — JSON payload from file
  • --base-url — override runtime URL

Configuration

The CLI defaults to http://localhost:8080.

Override via environment variable:

export KEYHOLE_RUNTIME_URL=http://your-runtime:8080
keyhole runtime health

Or per-command:

keyhole runtime health --base-url http://your-runtime:8080

Relationship to the SDK

The CLI is built on top of the keyhole-sdk Python package. The SDK provides the programmatic interface; the CLI wraps it for terminal use.

License

Apache 2.0 — see LICENSE.

Metadata

Release files for keyhole-cli 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for keyhole-cli 0.3.1
File Size Uploaded Provenance
keyhole_cli-0.3.1.tar.gz 67.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for keyhole-cli 0.3.1
File Interpreter ABI Platform
keyhole_cli-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 158.6 kB

Release files / keyhole_cli-0.3.1.tar.gz

Download URL keyhole_cli-0.3.1.tar.gz
Size 67.7 kB
Tags Source
SHA-256 checksum
How to use checksums
75cd28370dd0c42418e0851061798b59d6e75c3e63a79b7c7762219c7347c5c3
BLAKE2b-256 checksum
How to use checksums
62cac8e5994badb255d99937b872592803e3dfbfdc505dae4739361248170985
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / keyhole_cli-0.3.1-py3-none-any.whl

Download URL keyhole_cli-0.3.1-py3-none-any.whl
Size 90.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
608843e30e449662d49bc8a23c04a6931ef9e05694b1129e45204d715aa13597
BLAKE2b-256 checksum
How to use checksums
2c7b7797d74125e878868fb40687e5894dc86efb39ced22b1d687153d58dd937
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for keyhole-cli 0.3.1

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page