Skip to main content

CLI tool for Axon Protocol — interact with your Axon server from the terminal

Project description

Axon Protocol CLI (axon-cli)

The official command-line interface for the Axon Protocol ecosystem. Monitor and manage agents, memory, locks, and receipts directly from your terminal.


Installation

Install axon-cli locally in editable mode:

cd e:\Axon\axon-cli
pip install -e .

To install from production (once published):

pip install axon-cli

Command Reference

System Initialization & Health

  • axon init: Initialize or modify the .axon config file in the current directory.
  • axon doctor: Run quick readiness diagnostics on the database, Redis, and embedding model services.

Agent Management

  • axon agent register <name>: Register a new agent in a project. Automagically updates the local .axon config file with the newly generated API key.
  • axon agent me: Show current agent status, capabilities, and profile info.
  • axon agent list: List all agents registered in the active project.

Vector Memory

  • axon memory store "<content>": Store a semantic memory.
    • Option -t, --tag key=value: Attach custom metadata tags (can be passed multiple times).
    • Option -s, --scope <scope>: Specify memory visibility scope (e.g. agent or project, defaults to project).
    • Option --ttl <seconds>: Set time-to-live for the memory.
  • axon memory search "<query>": Find semantically similar memories.
    • Option -l, --limit <n>: Max results (default 10).
    • Option -m, --min-similarity <f>: Similarity threshold (default 0.5).
  • axon memory list: List recent memories in the project.
  • axon memory delete <memory_id>: Delete a memory permanently.

Distributed Locking

  • axon lock list: List active locks in the project.
  • axon lock status <resource_id>: Get detailed status of a resource lock.
  • axon lock acquire <resource_id>: Acquire an exclusive lock on a resource.
  • axon lock release <resource_id>: Release a lock you hold.

Reasoning Receipts

  • axon receipt list: Browse recent receipts.
  • axon receipt show <receipt_id>: View complete details and reasoning chain for a receipt.
  • axon receipt verify <receipt_id>: Recompute and cryptographically verify a receipt's integrity.

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

axon_protocol_cli-0.1.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

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

axon_protocol_cli-0.1.0-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file axon_protocol_cli-0.1.0.tar.gz.

File metadata

  • Download URL: axon_protocol_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for axon_protocol_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 47c996f61564550828cb59aa7d74417a3aa76695c3d947e39aab6edf078ed9ff
MD5 6a268cbd08b2d8ecc7bb8fb5ae310a9d
BLAKE2b-256 2356cf5a74f2d2e4b110a8b8d5618ba0ee535a2c22c15429bf0b1adcd69443b4

See more details on using hashes here.

File details

Details for the file axon_protocol_cli-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for axon_protocol_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bdecce32762177ea842da1edc76d76eaafacb05bf047381f324f8e7944a264c1
MD5 6fd16bd5ec0d3e1dbc68c1b7c0480efd
BLAKE2b-256 fca6aa956fcfb1fdbc7ae7011682ae06b4c64995821f1f2a88db291a8c2ecc2d

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