1 of 1

Command Line Interface for Agent Catalyst

The Agent Catalyst CLI is a powerful tool designed to simplify the creation, management, and execution of AI-driven workflows. With intuitive commands, users can seamlessly interact with Agent Catalyst projects directly from their terminal.

Installation

If your project was initialized using npm create agent-system, the CLI is already installed locally. You can access it using your package manager (e.g., npx asystem [command] or yarn asystem [command]).

To install the Agent Catalyst CLI globally, use one of the following commands:

Commands

init - Create a New Project

Initializes a new Agent Catalyst project in the specified directory.

Arguments:

path (Optional): The directory where the project will be created. Defaults to the current directory.

Options:

-t, --template <name> (Optional): Specifies a project template to use.

list - List Available Workflows

Displays all workflows available in the current project.

This command scans the workflows/ directory and lists:

Workflow IDs
Workflow Titles

exec - Execute a Workflow

Runs a specific workflow from the current project.

Arguments:

workflow (Required): The name of the workflow to execute.

Execution Process:

The CLI prompts for any user inputs defined in the workflow.
Outputs are streamed to the console in real-time.
Logs and generated files are saved to a timestamped directory in /outputs.

Examples

Create a New Project
Creates a new project in the my-new-project directory using the basic-template.
List Workflows
Displays all available workflows in the current project.
Execute a Workflow

Key Features

Ease of Use: Simple commands for creating projects, listing workflows, and executing tasks.
Real-Time Outputs: Monitor progress and view results directly in the console.
Automatic Logging: Save outputs and logs in organized, timestamped directories for easy reference.

The Agent Catalyst CLI is a robust and efficient solution for building, managing, and running AI workflows, streamlining the process of creating AI-driven applications.

Command Line Interface for Agent Catalyst

Installation

To install the Agent Catalyst CLI globally, use one of the following commands:

Commands

init - Create a New Project

Initializes a new Agent Catalyst project in the specified directory.

Arguments:

path (Optional): The directory where the project will be created. Defaults to the current directory.

Options:

-t, --template <name> (Optional): Specifies a project template to use.

list - List Available Workflows

Displays all workflows available in the current project.

This command scans the workflows/ directory and lists:

Workflow IDs
Workflow Titles

exec - Execute a Workflow

Runs a specific workflow from the current project.

Arguments:

workflow (Required): The name of the workflow to execute.

Execution Process:

The CLI prompts for any user inputs defined in the workflow.
Outputs are streamed to the console in real-time.
Logs and generated files are saved to a timestamped directory in /outputs.

Examples

Create a New Project
Creates a new project in the my-new-project directory using the basic-template.
List Workflows
Displays all available workflows in the current project.
Execute a Workflow

Key Features

Ease of Use: Simple commands for creating projects, listing workflows, and executing tasks.
Real-Time Outputs: Monitor progress and view results directly in the console.
Automatic Logging: Save outputs and logs in organized, timestamped directories for easy reference.

The Agent Catalyst CLI is a robust and efficient solution for building, managing, and running AI workflows, streamlining the process of creating AI-driven applications.