Quick Start

Get AgentsMesh up and running in six steps. This guide walks you through account creation, Runner setup, agent installation, and launching your first AI-powered Pod.

Create an Account

Register at the sign-up page with your email, username, and password. After submitting you will receive a verification email — check your spam folder if it does not arrive within a few minutes.

After verifying your email, the onboarding wizard will guide you to:

Create a personal workspace (one click) or a team workspace
Optionally join an existing organization via an invitation link

Setup a Runner

A Runner is the execution environment where AI agent Pods run. Install the AgentsMesh Runner on your development machine or server.

# Download and install the runner
curl -fsSL https://api.agentsmesh.ai/install.sh | sh

Register with a token

agentsmesh-runner register \
  --server https://api.agentsmesh.ai \
  --token <YOUR_TOKEN>
agentsmesh-runner run

Register with browser login

agentsmesh-runner login
agentsmesh-runner run

See Runner Setup for Docker, Homebrew, Linux packages, and Kubernetes deployment options.

Install AI Agent CLIs

Install the CLI tools you want to use on your Runner machine and set the required API key environment variables. The Runner auto-detects installed CLIs via PATH and reports available agents to the platform.

Claude Code

npm install -g @anthropic-ai/claude-code

export ANTHROPIC_API_KEY=sk-ant-...

Get your API key from console.anthropic.com

Codex CLI

npm install -g @openai/codex

export OPENAI_API_KEY=sk-...

Get your API key from platform.openai.com

Gemini CLI

npm install -g @google/gemini-cli

export GOOGLE_API_KEY=...

Get your API key from aistudio.google.com

After installing, restart the Runner or wait for the next heartbeat. The newly available agents will appear in the New Pod dialog.

Connect a Git Provider

Connecting a Git provider lets your Pods clone repositories and work in isolated Git worktrees. Go to Settings → Personal → Git Settings to add a provider.

GitHub

Add a Personal Access Token with the repo scope. github.com/settings/tokens

GitLab

Add a Personal Access Token with api and read_repository scopes. Self-hosted instances are supported.

See Git Integration for full setup instructions including SSH keys and Gitee.

Start a Pod

Create your first AgentPod and start coding with AI assistance!

Navigate to Workspace in the sidebar
Click New Pod
Select an AI agent type (Claude Code, Codex CLI, etc.)
Choose a Runner
Optionally select a repository and branch
Optionally link to a ticket for context
Add an initial prompt describing the task
Click Create

Interact with Your Agent

After creation the terminal view opens with a live session. Your AI agent begins executing the initial prompt or waits for input if none was provided.

Type follow-up prompts or commands directly in the terminal
Watch the agent status indicator — idle, executing, or waiting
The agent works inside the repository worktree if one was linked
Terminate the Pod from the toolbar when your task is complete