> For the complete documentation index, see [llms.txt](https://deusai.gitbook.io/agent-catalyst/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://deusai.gitbook.io/agent-catalyst/getting-started-with-agent-catalyst.md).

# 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
bash npm create agent-system@latest my-system
```

**Using yarn**

```bash
bash yarn create agent-system my-system
```

**Using bun**

```bash
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
bash cd my-system  
npm install  
```

***

#### Project Structure

Creating a new project initializes the following structure:

```bash
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
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
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,
    }),
  },
});
```

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://deusai.gitbook.io/agent-catalyst/getting-started-with-agent-catalyst.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.