### Install Dependencies and Run Development Server

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/CONTRIBUTING.md

Install project dependencies using pnpm and start the local development server. This is a common workflow for making and testing changes.

```bash
# Install dependencies
pnpm install

# Dev server (default: localhost:3000)
pnpm dev
```

--------------------------------

### Install and Run Hermes Agent Gateway

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Installs the hermes-agent and starts the gateway. Ensure you have Node.js 22+ and Python 3.11+ installed.

```bash
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash

hermes setup
hermes gateway run
```

--------------------------------

### Clone Repository and Configure Environment

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Clone the Hermes Workspace repository and copy the example environment file. This is the initial setup step before configuring LLM providers.

```bash
git clone https://github.com/outsourc-e/hermes-workspace.git
cd hermes-workspace
cp .env.example .env
```

--------------------------------

### Start All Hermes Services with pnpm

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Use this command to start the gateway, dashboard, and workspace simultaneously if installed via the one-liner.

```bash
pnpm start:all
```

--------------------------------

### Start Ollama and Hermes Workspace (Portable Mode)

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

First, start the Ollama server, then start Hermes Workspace pointing to the Ollama API. Note that sessions, memory, and skills will be unavailable in this mode.

```bash
# Start Ollama
OLLAMA_ORIGINS=* ollama serve

# Start workspace pointed at Ollama
HERMES_API_URL=http://127.0.0.1:11434 pnpm dev
```

--------------------------------

### Install and Run Hermes Workspace

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Clones the Hermes Workspace repository, installs dependencies, configures the API URL, and starts the development server. Ensure Node.js 22+ is installed.

```bash
# In a new terminal
git clone https://github.com/outsourc-e/hermes-workspace.git
cd hermes-workspace
pnpm install
cp .env.example .env
printf '
HERMES_API_URL=http://127.0.0.1:8642
' >> .env
pnpm dev                   # Starts on http://localhost:3000
```

--------------------------------

### Install Hermes Dashboard Service

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/dashboard-service.md

Makes the installation script executable and then runs it to install the Hermes dashboard service. Defaults are used unless overridden.

```bash
chmod +x scripts/install-dashboard-service.sh
scripts/install-dashboard-service.sh
```

--------------------------------

### Start Hermes Gateway

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/AGENT-PAIRING.md

Run the hermes gateway in the foreground for debugging. If using systemd, install the service first and then start it.

```bash
# Start in foreground (recommended for debugging — you see all output)
hermes gateway run
```

```bash
# OR if using systemd
hermes gateway install   # creates the service
systemctl --user start claude-gateway
```

--------------------------------

### Build and Start Production Server

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/FEATURES-INVENTORY.md

Execute this command to create a production build and start the Node.js server on port 3000.

```bash
pnpm build && pnpm start  # Node.js server on port 3000
```

--------------------------------

### Clone and Run Hermes Playground Locally

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/playground/README.md

Clone the repository, install dependencies, and start the development server to access the Hermes Playground. Open the provided URL in multiple browser tabs to test multiplayer functionality.

```bash
git clone https://github.com/outsourc-e/hermes-workspace
cd hermes-workspace
pnpm install
pnpm dev
# open http://localhost:3001/playground in two browser tabs
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/swarm/QUICKSTART.md

Install all necessary project dependencies using pnpm. Ensure you have pnpm installed and configured.

```bash
pnpm install
```

--------------------------------

### Install Project Dependencies and Build

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/dashboard-service.md

Installs project dependencies using pnpm and builds the project. Ensure you have configured your .env file if it's not already set up.

```bash
pnpm install
pnpm build
cp .env.example .env # if you have not configured it yet
```

--------------------------------

### Start Hermes Dashboard

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/AGENT-PAIRING.md

Command to start the hermes dashboard.

```bash
hermes dashboard
```

--------------------------------

### Start Workspace and Verify Pairing

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/AGENT-PAIRING.md

Navigate to the hermes-workspace directory and start the development server. Look for specific output messages indicating successful pairing.

```bash
cd ~/hermes-workspace   # or wherever it's installed
pnpm dev
```

--------------------------------

### Run Hermes Playground with Hosted Hub

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/playground/README.md

Start the development server to automatically connect to a hosted Cloudflare Worker and Durable Object hub for cross-device multiplayer testing without local setup.

```bash
# Just run pnpm dev. The .env already wires VITE_PLAYGROUND_WS_URL to a
# Cloudflare Worker + Durable Object hub at:
#   wss://hermes-playground-ws.myaurora-agi.workers.dev/playground
# Open /playground in two devices on different networks — they'll meet there.
pnpm dev
```

--------------------------------

### Install Prerequisites using winget and npm

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/windows-setup-guide.md

Installs sqlite3 CLI, Claude CLI, and pnpm using Windows Package Manager and npm. Copy the sqlite3.exe to a directory in your PATH.

```powershell
# 1. sqlite3 CLI (for kanban/tasks)
winget install SQLite.SQLite --accept-package-agreements --accept-source-agreements
# Then copy sqlite3.exe to a Git Bash PATH dir:
# Source: C:\Users\<you>\AppData\Local\Microsoft\WinGet\Packages\SQLite.SQLite_...\sqlite3.exe
# Dest:   C:\Users\<you>\bin\sqlite3.exe

# 2. Claude CLI (for Claude Tasks / Conductor)
npm install -g @anthropic-ai/claude-code

# 3. pnpm (if not installed)
npm install -g pnpm
```

--------------------------------

### One-line Install for Hermes Workspace

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Installs hermes-agent, clones the repository, sets up environment variables, and installs dependencies with a single command. Recommended for local development on macOS and Linux.

```bash
curl -fsSL https://raw.githubusercontent.com/outsourc-e/hermes-workspace/main/install.sh | bash
```

--------------------------------

### Build Windows Installer

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/AGENTS.md

Generates an NSIS installer for the Windows application, located in the `release/` directory.

```bash
electron:build:win
```

--------------------------------

### Install SQLite CLI on Windows

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/AGENTS.md

Installs the SQLite command-line interface using Windows Package Manager and provides instructions for adding it to the Git Bash PATH.

```bash
winget install SQLite.SQLite
```

--------------------------------

### Start Hermes Gateway, Dashboard, and Workspace

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Commands to start the Hermes Agent gateway, dashboard, and the main workspace application. Ensure the `HERMES_API_URL` and `HERMES_DASHBOARD_URL` environment variables are set correctly.

```bash
hermes gateway run          # Starts core APIs on :8642
hermes dashboard            # Starts dashboard APIs on :9119
HERMES_API_URL=http://127.0.0.1:8642 \
HERMES_DASHBOARD_URL=http://127.0.0.1:9119 \
pnpm dev
```

--------------------------------

### Install Claude CLI

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/AGENTS.md

Installs the official Claude CLI globally, which is necessary for using Claude Tasks and Conductor features.

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

--------------------------------

### Start Hermes Workspace with Atomic Chat (Portable Mode)

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Use this command to start the Hermes Workspace pointed directly at an Atomic Chat instance. Ensure Atomic Chat is running and a model is loaded.

```bash
# Start workspace pointed at Atomic Chat
HERMES_API_URL=http://127.0.0.1:1337/v1 pnpm dev
```

--------------------------------

### Start Docker Services

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Start the Hermes Agent and Hermes Workspace services using Docker Compose. This command pulls pre-built images and launches the containers.

```bash
docker compose up
```

--------------------------------

### Start and Stop Stable Mode

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/FEATURES-INVENTORY.md

Commands to manage the stable mode, which runs as a background process. Use `start:stable` to initiate and `stop:stable` to terminate.

```bash
pnpm start:stable  # Background process via scripts/start-stable.sh
```

```bash
pnpm stop:stable   # Stop via scripts/stop-stable.sh
```

--------------------------------

### Start Hermes Workspace on Windows (PowerShell)

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Execute this PowerShell script from the repo root to start the Hermes Workspace and its agent in WSL. It can also force a clean tmux session restart.

```powershell
# from the repo root
.\scripts\start-hermes-workspace.ps1
```

```powershell
.\scripts\start-hermes-workspace.ps1 -Restart
```

--------------------------------

### Set Up Environment Variables

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/CONTRIBUTING.md

Copy the example environment file and edit it to configure your local development environment. Ensure the HERMES_API_URL is set correctly.

```bash
cp .env.example .env
# Edit .env — set HERMES_API_URL (default: http://127.0.0.1:8642)
```

--------------------------------

### Quick Docker Compose Setup

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/docker.md

Use this command for a single-host, localhost-only deployment. Ensure you have cloned the repository and set up your .env file with at least one provider key.

```bash
git clone https://github.com/outsourc-e/hermes-workspace
cd hermes-workspace
cp .env.example .env
# add at least one provider key (e.g. OPENROUTER_API_KEY=...)
docker compose up -d
open http://localhost:3000
```

--------------------------------

### GET /api/swarm-memory Response Example

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/swarm2-memory-framework-spec.md

Example JSON response structure for retrieving swarm memory data. It includes worker ID, memory kind, path, and a list of files with their names, paths, and content.

```json
{
  "ok": true,
  "workerId": "swarm5",
  "kind": "mission",
  "path": "...",
  "files": [
    { "name": "SUMMARY.md", "path": "...", "content": "..." }
  ]
}
```

--------------------------------

### Local Development Setup

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/playground-ws-worker/README.md

Commands to run the worker locally for development and how to configure the client environment variables.

```bash
pnpm wrangler dev            # hot-reload on http://localhost:8787
```

```bash
VITE_PLAYGROUND_WS_URL=ws://localhost:8787/playground pnpm dev
```

--------------------------------

### Task API Endpoint Examples

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/swarm2-agent-ide-spec.md

Illustrates GET requests to retrieve tasks assigned to a specific worker. Supports filtering by assignee and an option to include completed tasks.

```http
GET /api/claude-tasks?assignee=swarm4&include_done=false
```

```http
GET /api/claude-tasks?assignee=swarm4&include_done=true
```

--------------------------------

### Build Workspace from Source

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Use a development overlay to build the workspace from local source code and have changes hot-built into the container. This is for local development.

```bash
docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build
```

--------------------------------

### Chat History API Endpoint

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/swarm2-agent-ide-spec.md

Example of a GET request to retrieve chat history for a specific worker, with an option to limit the number of messages returned. The response includes worker ID, session key, and a list of messages.

```http
GET /api/swarm-chat?workerId=swarm4&limit=30
```

```json
{
  "workerId": "swarm4",
  "sessionKey": "...",
  "messages": [
    { "role": "user", "content": "...", "timestamp": 1777269485753 },
    { "role": "assistant", "content": "...", "timestamp": 1777269490000 }
  ]
}
```

--------------------------------

### Model Context - Compact Tool Summary Format

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/tool-artifacts-context-plan.md

Example of how a tool's completion and summary should be presented to the model for context. It includes a pointer to the full output stored as an artifact.

```text
Tool read_file completed.
Summary: Read chat-message-list.tsx lines 680-1499.
Full output stored as artifact toolout_abc123.
Use artifact_read(toolout_abc123, offset, limit) if needed.
```

--------------------------------

### Install Hermes Agent

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/AGENT-PAIRING.md

Install the Hermes Agent using the official Nous installer script. This script is compatible with macOS, Linux, and WSL.

```bash
# Official Nous installer — works on macOS, Linux, WSL
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
```

--------------------------------

### Build Project

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/OVERNIGHT-PR-SHAKEDOWN.md

Build the project using pnpm. This is a prerequisite for testing.

```bash
pnpm build
```

--------------------------------

### Prepare Workspace and Check Project

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/swarm2-agent-ide-spec.md

Before starting the build/test/git loop, navigate to the hermes-workspace, print the current directory, verify the existence of package.json, and extract the project name using jq.

```bash
cd /Users/aurora/hermes-workspace &&
pwd &&
test -f package.json &&
jq -r .name package.json
```

--------------------------------

### Start Hermes Agent gateway

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/FEATURES-INVENTORY.md

Starts the Hermes Agent gateway process.

```APIDOC
## POST /api/start-claude

### Description
Start Hermes Agent gateway

### Method
POST

### Endpoint
/api/start-claude
```

--------------------------------

### Start Hermes Gateway and Workspace on WSL

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/troubleshooting.md

On WSL, the gateway's Python cold-start can cause health check timeouts. Start the gateway in one terminal and wait for it to be ready before starting the Workspace in a second terminal to avoid this issue.

```bash
# Terminal 1 — start gateway first, wait for it
hermes gateway run
# Wait until you see "Uvicorn running on http://127.0.0.1:8642"

# Terminal 2 — then start workspace
cd ~/hermes-workspace && pnpm dev
```

--------------------------------

### Check Hermes Agent Installation

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/AGENT-PAIRING.md

Verify if the Hermes Agent is installed by checking its version. This is the first step in the pairing process.

```bash
hermes --version
```

--------------------------------

### Check Startup Output for Pairing Status

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/AGENT-PAIRING.md

Examine the console output after starting the workspace. The presence of '[claude-api] Configured API' and '[gateway] ... mode=enhanced-fork' confirms successful pairing.

```bash
[claude-api] Configured API: http://127.0.0.1:8642
[gateway] gateway=http://127.0.0.1:8642 ... mode=enhanced-fork core=[health, chatCompletions, models, streaming]
```

--------------------------------

### Start Hermes Workspace Development Server

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Starts the Hermes Workspace development server after configuration. The default port is 3000, but can be overridden.

```bash
pnpm dev                            # http://localhost:3000 (override with PORT=4000 pnpm dev)
```

--------------------------------

### Start Workspace Development Server

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/AGENTS.md

Launches the workspace development server. This command is part of the required services for full functionality on Windows.

```bash
pnpm dev
```

--------------------------------

### Clone and Install Hermes Workspace

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/README.md

Clones the Hermes Workspace repository and installs its dependencies. This is the first step when attaching to an existing Hermes Agent.

```bash
git clone https://github.com/outsourc-e/hermes-workspace.git
cd hermes-workspace
pnpm install
cp .env.example .env
```

--------------------------------

### Assignment Contract Example

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/docs/swarm2-autopilot-orchestration-spec.md

Example of the JSON structure returned by /api/swarm-decompose for task assignments. It includes worker ID, task details, rationale, and dependencies.

```json
{
  "assignments": [
    {
      "workerId": "swarm4",
      "task": "Research the options and produce a concise recommendation with sources.",
      "rationale": "Research lane owns technical synthesis.",
      "expectedOutput": "Recommendation with tradeoffs and next action.",
      "dependsOn": [],
      "reviewRequired": false
    }
  ],
  "unassigned": []
}
```

--------------------------------

### Launch Electron App in Development Mode

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/AGENTS.md

Starts the Electron desktop application in development mode, which includes building the Vite client and enabling hot-reloading.

```bash
pnpm electron:dev
```

--------------------------------

### Run Unpacked Electron Build on Windows

Source: https://github.com/outsourc-e/hermes-workspace/blob/main/AGENTS.md

Executes the unpacked Electron application build for testing purposes on Windows.

```bash
release/win-unpacked/hermes-workspace.exe
```