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:

bash # Using npm
npm install -g @agentsystem/cli

# Using yarn
yarn global add @agentsystem/cli

# Using bun
bun add -g @agentsystem/cli

---

Commands

init - Create a New Project

Initializes a new Agent Catalyst project in the specified directory.

bash asystem init [path] [options]
# Alias
asystem i [path] [options]

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.

bash asystem list
# Alias
asystem ls

This command scans the workflows/ directory and lists:

• Workflow IDs

• Workflow Titles

---

exec - Execute a Workflow

Runs a specific workflow from the current project.

bash asystem exec <workflow>
# Alias
asystem x <workflow>

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

1. Create a New Project

   bash asystem init my-new-project -t basic-template

   Creates a new project in the my-new-project directory using the basic-template.

2. List Workflows

   bash asystem list

   Displays all available workflows in the current project.

3. Execute a Workflow

   bash asystem exec translate-quote

   Executes the translate-quote workflow, streams the progress to the console, and saves the results in the /outputs directory.

---

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.