Zytron CLI

The Zytron Command Line Interface (CLI) provides a streamlined way to manage and execute your network of agents directly from the command line. This guide outlines the installation process and details the available commands to help you efficiently utilize Zytron's capabilities.

Installation

You can install the zytron package using pip or poetry.

Using pip

pip3 install -U zytron

Using poetry

poetry add zytron

Once installed, you can run the Zytron CLI with the following command:

poetry run zytron help

Zytron CLI - Help

When running zytron help, you'll see the following output:


__________         __                        
\____    /___.__._/  |________  ____   ____  
  /     /<   |  |\   __\_  __ \/  _ \ /    \ 
 /     /_ \___  | |  |  |  | \(  <_> )   |  \
/_______ \/ ____| |__|  |__|   \____/|___|  /
        \/\/                              \/ 



    Zytron CLI - Help

    Commands:
    onboarding    : Starts the onboarding process
    help          : Shows this help message
    get-api-key   : Retrieves your API key from the platform
    check-login   : Checks if you're logged in and starts the cache
    read-docs     : Redirects you to zytron cloud documentation!
    run-agents    : Run your Agents from your agents.yaml

CLI Commands

Below is a detailed explanation of the available commands:

  • onboarding Starts the onboarding process to help you set up your environment and configure your agents.

Usage:

zytron onboarding
  • help Displays the help message, including a list of available commands.

Usage:

zytron help
  • get-api-key Retrieves your API key from the platform, allowing your agents to communicate with the Zytron platform.

Usage:

zytron get-api-key
  • check-login Verifies if you are logged into the platform and starts the cache for storing your login session.

Usage:

zytron check-login
  • read-docs Redirects you to the official Zytron documentation on the web for further reading.

Usage:

zytron read-docs
  • run-agents Executes your agents from the agents.yaml configuration file, which defines the structure and behavior of your agents. Refer to this document for how to leverage yamls for fast, reliable, and simple agent orchestration. You can customize what yaml file to run with --yaml-file

Usage:

zytron run-agents --yaml-file agents.yaml

Last updated