Getting Started with Agent Catalyst

You don’t need to be a professional programmer to use Agent Catalyst. However, comfort with the command line, a curious mindset, and an interest in solving challenges will help you maximize its potential.

---

Creating an Agent CatalystProject

First, ensure you have a JavaScript runtime installed (like Node.js or Bun). Use your preferred package manager to initialize a new Agent Catalyst project. Specify the project name via the command line, or use . to scaffold the project in the current directory.

Using npm

bash npm create agent-system@latest my-system

Using yarn

bash yarn create agent-system my-system

Using bun

bash bun create agent-system my-system

Follow the prompts during initialization. Once complete, navigate to the project directory and install the necessary dependencies:

Install Dependencies

bash cd my-system  
npm install  

---

Project Structure

Creating a new project initializes the following structure:

bash my-system/
├── flows/               # Your workflows are stored here.
│   └── hello-world.mdx  # Example workflow.
├── outputs/             # Execution results are saved here.
├── .env                 # Store secrets like API keys here.
├── agent-system.config.js # Project configuration file.
└── package.json

Key Files:

• 📂 flows/: Where all your workflows are created and stored.

• 📂 outputs/: Stores the results of executed workflows.

• .env: Securely stores secrets like API keys for AI providers.

• agent-system.config.js: The main configuration file for your project.

---

Next Steps Before Running Workflows

1. Configure AI Providers

Add your AI provider settings to the agent-system.config.js file.

2. Add API Keys

Securely store your API keys in the .env file.

---

Command-Line Interface

In a project with Agent Catalyst installed, you can use the asystem CLI tool to manage, create, and execute workflows. To see a full list of commands, use:

Display Help

bash npx asystem help

---

Project Configuration

When running workflows with the asystem CLI, Agent Catalyst will look for an agent-system.config.js (or .ts) file in the project root. If a .env file is present, it will be loaded first, making its variables available via process.env.

Example Configuration (agent-system.config.js)

javascript import { defineConfig } from '@agent-system/core';
import { createOpenAI } from '@ai-sdk/openai';

export default defineConfig({
  providers: {
    openai: createOpenAI({
      apiKey: process.env.MY_OPENAI_KEY,
    }),
  },
});

---