Skip to main content

CLI for interacting with Keyhole-compatible runtimes

Project description

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.

Project details


Download files

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

Source Distribution

keyhole_cli-0.1.1.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

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

keyhole_cli-0.1.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file keyhole_cli-0.1.1.tar.gz.

File metadata

  • Download URL: keyhole_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for keyhole_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a41d0a513f9401892a1bd8ef93de527b5d92c52101d36227481f42a6ae00aa2e
MD5 41a7d3bb687ee81895344e44d9d663c8
BLAKE2b-256 0bb27222332f99a196895e8307b10e60dce05ebe525a9d3f55608e917f64e2ac

See more details on using hashes here.

File details

Details for the file keyhole_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: keyhole_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for keyhole_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a05a34ed28225e2bcb050761a5f8ab41b8d75424caf285b54646a6ebb88740b5
MD5 536e485c6c157da16a00ed28cada1385
BLAKE2b-256 be22f6bf39c2f05320846f79e61ec3166a1b7f7b805e356b35120c6f05897c04

See more details on using hashes here.

Supported by

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