CLI
The Coralizer CLI is a command line tool that helps developers create, configure, and manage Coralized Agents. It streamlines the process of registering agents, managing communication threads, and simulating interactions. This guide provides an overview of the main commands and workflows.
1. Installation
Install the CLI using pip:
Verify the installation:
2. Commands
coralizer init <agent-name>
coralizer init <agent-name>
Initialise a new Coralized Agent project. This sets up the directory structure, configuration files, and boilerplate code.
coralizer register <agent-name>
coralizer register <agent-name>
Register your agent with a running Coral Server.
coralizer message
coralizer message
Send a message to a registered agent within a thread.
coralizer list-agents
coralizer list-agents
List all registered agents on the Coral Server.
coralizer list-threads
coralizer list-threads
View available threads and participants.
3. Configuration
Each Coralized Agent uses a coral.yaml file that defines:
- Agent ID
- Description
- Tools exposed
- Memory preferences
- Message handlers
This configuration is required for registration and runtime operations.
Notes
- The CLI assumes the Coral Server is running.
- Interaction and tool execution use the MCP format.
- Thread and agent operations are stateless and scoped.
The CLI is an essential part of the Coral developer toolkit. It provides a lightweight way to interact with agents and experiment with Coral’s communication model in local or remote setups.
CLI
The Coralizer CLI is a command line tool that helps developers create, configure, and manage Coralized Agents. It streamlines the process of registering agents, managing communication threads, and simulating interactions. This guide provides an overview of the main commands and workflows.
1. Installation
Install the CLI using pip:
Verify the installation:
2. Commands
coralizer init <agent-name>
coralizer init <agent-name>
Initialise a new Coralized Agent project. This sets up the directory structure, configuration files, and boilerplate code.
coralizer register <agent-name>
coralizer register <agent-name>
Register your agent with a running Coral Server.
coralizer message
coralizer message
Send a message to a registered agent within a thread.
coralizer list-agents
coralizer list-agents
List all registered agents on the Coral Server.
coralizer list-threads
coralizer list-threads
View available threads and participants.
3. Configuration
Each Coralized Agent uses a coral.yaml file that defines:
- Agent ID
- Description
- Tools exposed
- Memory preferences
- Message handlers
This configuration is required for registration and runtime operations.
Notes
- The CLI assumes the Coral Server is running.
- Interaction and tool execution use the MCP format.
- Thread and agent operations are stateless and scoped.
The CLI is an essential part of the Coral developer toolkit. It provides a lightweight way to interact with agents and experiment with Coral’s communication model in local or remote setups.