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 ping
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.

alloy ping is the authenticated connectivity check. It confirms who you are, which host you reached, and which server build answered the request.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: alloy_runtime_cli-0.2.32.tar.gz
  • Upload date:
  • Size: 284.9 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.32.tar.gz
Algorithm Hash digest
SHA256 b4acb6b54eed7088b125a028d7c3dedca0a10e44270bb5762aea5e5559535322
MD5 07cc797cd62e9673c678fbbcd5772a84
BLAKE2b-256 4ba05d93dd9000cad90eec620a7821370a4556453cadfdc8b9d88e5a8f027e14

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for alloy_runtime_cli-0.2.32-py3-none-any.whl
Algorithm Hash digest
SHA256 c1c84ad4d2bcc0cfe628d2c821ccc569d902499add4c0ab8363f139fff5d7610
MD5 b114dd84442faa8ae6153ad3e7f00bb5
BLAKE2b-256 2866673fac61f4d47203c6d3495cbc1df89dceeb56b6f463839e25fd23b7e1f0

See more details on using hashes here.

Provenance

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