Installation

Get agentcmd running on your machine in under 2 minutes.

Note: This guide covers installing agentcmd as a standalone application for workflow automation. If you're contributing to the agentcmd monorepo, see the development setup in README.md.

Prerequisites

Before installing, ensure you have:

Node.js 22+ - Download here
AI CLI tool - At least one of:
- Claude Code (recommended)
- OpenAI Codex
- Google Gemini

New to AI CLIs? Claude Code is the most mature option. Install it first, then add others later.

Install agentcmd

Run the installer which sets up the database, config, and CLI:

npx agentcmd install

This will:

Create ~/.agentcmd/ directory
Initialize SQLite database
Generate JWT secret for authentication
Create default config file

Output:

Installation Output

✓ Created ~/.agentcmd directory
✓ Initialized database at ~/.agentcmd/agentcmd.db
✓ Generated JWT secret
✓ Created config at ~/.agentcmd/config.json

<AgentCMD /> installed successfully!

Next steps:
  1. Start the server: npx agentcmd start
  2. Open UI: http://localhost:4100

Verify Installation

Check that agentcmd is installed correctly:

npx agentcmd config --show

You should see your configuration:

~/.agentcmd/config.json

{
  "server": {
    "port": 4100,
    "host": "0.0.0.0"
  },
  "inngest": {
    "port": 8288,
    "devMode": true
  },
  "database": {
    "path": "~/.agentcmd/agentcmd.db"
  }
}

Installing Supporting CLI Tools

agentcmd requires at least one AI CLI tool. Here's how to install the most common options:

Claude Code (Recommended)

Claude Code is the most mature AI CLI with excellent workflow support.

macOS/Linux:

curl -fsSL https://code.claude.com/install.sh | sh

Manual Installation:

Visit code.claude.com
Download installer for your OS
Follow setup instructions
Run claude --version to verify

OpenAI Codex

npm:

npm install -g openai-codex

Verify:

codex --version

GitHub CLI (gh)

Many workflows use gh for PR creation and issue management.

macOS:

brew install gh

Linux:

# Debian/Ubuntu
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install gh

# Fedora/RHEL
sudo dnf install gh

Windows:

winget install --id GitHub.cli

Authenticate:

gh auth login

Next Steps

Quick Start

Launch the UI and create your first project

First Workflow

Build a simple 10-line workflow

Configuration

Customize ports, logging, and more

Installation complete! Continue to Quick Start to launch the UI and create your first project.

Installation

Quick Start

First Workflow

Configuration

On this page