CLI Commands

Athyr provides a command-line interface for managing the platform.

Global Options

These options work with any command:

athyr [command] --config /path/to/athyr.yaml
athyr --version
athyr --help
OptionDescription
--configPath to configuration file (default: ./athyr.yaml)
--versionDisplay version information
--helpDisplay help for any command

Commands

athyr serve

Start the Athyr server.

athyr serve
athyr serve --data-dir /var/lib/athyr
athyr serve --config /etc/athyr/athyr.yaml

Options:

OptionDescription
--data-dirData directory (overrides config file)

Output:

    _   _   _
   /_\ | |_| |_  _  _ _ _
  / _ \|  _| ' \| || | '_|
 /_/ \_\\__|_||_|\_, |_|
                 |__/

Provider  embedded-nats
Data      ./data
LLM backends  2
    - local
    - cloud

Press Ctrl+C to stop

The server runs in the foreground. Use Ctrl+C to stop gracefully.

athyr status

Check if the server is healthy.

athyr status

Output (healthy):

Server status: UP
  Provider: embedded-nats
  Data: ./data
  Storage: OK
  Messaging: OK

Output (down):

Server status: DOWN
  Cannot start: failed to connect to data store

athyr agents

Manage registered agents.

athyr agents list

Display all connected agents.

athyr agents list

Output:

ID        NAME            STATUS      SKILLS  LAST SEEN
8a3b2c1d  weather-agent   connected   2       3s ago
f4e5d6c7  triage-agent    connected   1       1s ago
a1b2c3d4  calculator      connected   3       5s ago

Total: 3 agent(s)
ColumnDescription
IDFirst 8 characters of agent’s unique ID
NAMEAgent’s display name from AgentCard
STATUSConnection status (connected/disconnected)
SKILLSNumber of registered capabilities
LAST SEENTime since last heartbeat

Configuration File

Athyr looks for configuration in this order:

  1. Path specified by --config flag
  2. ./athyr.yaml in current directory
  3. /etc/athyr/athyr.yaml

If no configuration file is found, Athyr uses defaults.

See Configuration for full configuration options.

Exit Codes

CodeMeaning
0Success
1General error

Next Steps