⚪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
Using poetry
Once installed, you can run the Zytron CLI with the following command:
Zytron CLI - Help
When running zytron help
, you'll see the following output:
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:
help Displays the help message, including a list of available commands.
Usage:
get-api-key Retrieves your API key from the platform, allowing your agents to communicate with the Zytron platform.
Usage:
check-login Verifies if you are logged into the platform and starts the cache for storing your login session.
Usage:
read-docs Redirects you to the official Zytron documentation on the web for further reading.
Usage:
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:
Last updated