Skip to content
herdctl

Getting Started

Coming Soon

This guide will walk you through installing herdctl and running your first autonomous agent fleet. Full documentation is in progress.

What You’ll Learn

Section titled “What You’ll Learn”

Installation

How to install herdctl via npm, verify your setup, and configure prerequisites like Claude Code CLI.

Creating Your First Agent

Define an agent in YAML with a name, workspace, schedule, and prompt. Understand the basic structure.

Running Your Fleet

Start the herdctl daemon, watch agents execute on schedule, and manage your fleet from the CLI.

Monitoring Output

View agent logs, track job status, and understand what your agents are doing in real-time.

Prerequisites

Section titled “Prerequisites”

Before you begin, you’ll need:

  • Node.js 18+ - herdctl is built on Node.js
  • Claude Code CLI - Agents use Claude Code under the hood
  • Git - For workspace management and repo cloning

Quick Preview

Section titled “Quick Preview”

Here’s a taste of what running herdctl looks like:

Terminal window
# Install herdctl
npm install -g herdctl


# Initialize a new project
herdctl init


# Start your fleet
herdctl start

And a simple agent configuration:

agents/my-agent.yaml
name: my-first-agent
description: "My first autonomous agent"


workspace: my-project
repo: username/my-project


schedules:
  - name: check-issues
    trigger:
      type: interval
      every: 10m
    prompt: |
      Check for open issues and report status.

Background Reading

Section titled “Background Reading”

While this guide is being completed, explore these concepts to understand how herdctl works:

Agents Understand what agents are and how they operate autonomously
Schedules Learn how triggers determine when agents run
Jobs Discover how individual agent executions are tracked
Workspaces See how agents manage their working directories

Configuration Reference

Section titled “Configuration Reference”

For detailed configuration options, see: