Documentation
•
2 min read

Getting Started

How to install and run your first AI Agent Flow task.

Last updated2026-02-28

AI Agent Flow (v1.0.0) is a local-first, multi-agent orchestration framework designed for software engineering. This guide will help you install the CLI and run your first autonomous task.

Pro Tip: For the best results, use Claude 3.5 Sonnet or GPT-4o. These models have superior reasoning capabilities for architecture and complex code generation.

Prerequisites

  • Node.js: Version 18 or higher.
  • LLM API Key: You'll need an API key from a supported provider — or use a free-tier option to get started with no credit card:
    • Free options: Groq or OpenRouter both have generous free tiers
    • Cloud options: Anthropic, OpenAI, or Google Gemini
    • Local / no key: Ollama runs models entirely on your machine
Security Note: Always keep your API keys private. Use environment variables or global config instead of hardcoding them in requests.

Installation

Install the package globally via npm:

npm install -g @aiagentflow/cli

Verify the installation:

aiagentflow --version

Running Your First Task

Navigate to your project directory and run:

aiagentflow run "Add a unit test for the authentication middleware"

The CLI will:

  1. Analyze: Look at your codebase and the request.
  2. Plan: The Architect agent will draft an implementation plan.
  3. Code: The Coder agent will write the test file.
  4. Verify: The Reviewer and Judge agents will ensure the code meets the requirements.

Next Steps

Check out our Configuration Guide to learn how to set up your preferred AI providers.