Skip to main content

Alloy Runtime CLI - Command-line interface for Alloy Runtime server

Project description

alloy-runtime-cli

Terminal client for Alloy Runtime.

Install

pip install alloy-runtime-cli

For isolated user installs, pipx is also a good fit:

pipx install alloy-runtime-cli

Command

The installed command is alloy.

alloy --help
alloy --help-json
alloy --help-markdown
alloy --help-toon
alloy login
alloy credentials supported
alloy credentials supported --kind tools
alloy --api-url https://your-alloy-runtime-host whoami
alloy api-keys create --scope read --scope update --scope use --description "automation key"

Use alloy --help-json when automation or agents need recursive machine-readable CLI help as JSON. Use alloy --help-markdown for the same help tree rendered as Markdown. Use alloy --help-toon for the same help tree rendered as TOON. For session-wide help rendering, set ALLOY_RUNTIME_HELP_FORMAT=json, ALLOY_RUNTIME_HELP_FORMAT=markdown, or ALLOY_RUNTIME_HELP_FORMAT=toon and run alloy --help.

General command output also supports --format toon alongside compact, json, and lines. The CLI pins toon-format from the upstream GitHub source because the PyPI stub release is not usable yet.

Configuration

The CLI reads configuration in this order:

  1. CLI flags such as --api-url and --api-key
  2. Environment variables like ALLOY_RUNTIME_API_URL
  3. Stored credentials in ~/.alloy-runtime/config

Use alloy login to save an API key locally, or set the environment variables when running on a VPS.

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

alloy_runtime_cli-0.2.4.tar.gz (293.7 kB view details)

Uploaded Source

Built Distribution

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

alloy_runtime_cli-0.2.4-py3-none-any.whl (480.3 kB view details)

Uploaded Python 3

File details

Details for the file alloy_runtime_cli-0.2.4.tar.gz.

File metadata

  • Download URL: alloy_runtime_cli-0.2.4.tar.gz
  • Upload date:
  • Size: 293.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for alloy_runtime_cli-0.2.4.tar.gz
Algorithm Hash digest
SHA256 4eb1b19513c9ec15f69fc79f2a09863cdec13493474da0522d9417d55c2c1035
MD5 c247ff9390da4e96434b29091e9ac3f7
BLAKE2b-256 3c53ba3a7673c2db4c6f9e5e320922ad4951128ed5ce22330877d6ae523a02f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for alloy_runtime_cli-0.2.4.tar.gz:

Publisher: publish-python-packages.yml on alloy-runtime/alloy-runtime

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

File details

Details for the file alloy_runtime_cli-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for alloy_runtime_cli-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 aff41349e4e3435bc89ca799614076a0c96cc1fac9e492de733c170d0713f3bd
MD5 076f805c11998a887cb3b59c244ae859
BLAKE2b-256 2108b2372a85bf7865dc5c3d55ae253d4d6ddcc0a09e11fa127578f2eca9cfbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for alloy_runtime_cli-0.2.4-py3-none-any.whl:

Publisher: publish-python-packages.yml on alloy-runtime/alloy-runtime

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

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