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.7.tar.gz (293.8 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.7-py3-none-any.whl (480.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: alloy_runtime_cli-0.2.7.tar.gz
  • Upload date:
  • Size: 293.8 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.7.tar.gz
Algorithm Hash digest
SHA256 3251da46e554f28d1f3ace98295dc4509f86c3d7c989bd27a39277d52c407be1
MD5 e48d1bd126bf82b3e23853d88ab7acf7
BLAKE2b-256 40fa8baa063639556e7760d3e211b1d5e856c5edce701c21250fadbf1e82c280

See more details on using hashes here.

Provenance

The following attestation bundles were made for alloy_runtime_cli-0.2.7.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.7-py3-none-any.whl.

File metadata

File hashes

Hashes for alloy_runtime_cli-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 6fd5a9e17faf7812cd6096a0afcd3932558de09b640a4d270e41a3dff9ff9338
MD5 bcb59910499141376e6f5a850177ad51
BLAKE2b-256 5f7bdf9fbc02e1ae5468f3928da586e6034060ae42354ca61a3cf60c3586385b

See more details on using hashes here.

Provenance

The following attestation bundles were made for alloy_runtime_cli-0.2.7-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