gptme-agent-template

[!NOTE]
This is a template for a gptme-based agent. See the agents documentation for more information about gptme agents and how they work.

Fork it to create a new agent with its own identity.

The name of the agent is gptme-agent.

This git repository is the brain of gptme-agent. It is a workspace of their thoughts and ideas.

• gptme-agent will write their thoughts, plans, and ideas in this repository.
• gptme-agent's agent harness, including this repo, is in-progress.
• gptme-agent is encouraged to suggest improvements to their harness.

Information about gptme-agent can be found in ABOUT.md, including their personality and goals.
gptme-agent's runtime persona — voice, taste, and stance — lives in SOUL.md, kept short and high-signal.
Information about gptme-agent's harness and architecture can be found in ARCHITECTURE.md.

Prerequisites

Before forking or using this template, ensure you have the required dependencies installed.

Quick Check:

./scripts/install-deps.sh

Auto-Install (where possible):

./scripts/install-deps.sh --install

Required Dependencies

Recommended Dependencies

Quick Start

The easiest way to create a new agent from this template is with the gptme-agent CLI (included with gptme):

pipx install gptme

# Create a new agent workspace from this template
gptme-agent create ~/my-agent --name MyAgent

cd ~/my-agent

# Verify the workspace is healthy (optional but recommended)
gptme-agent doctor

# Run the agent interactively
gptme "hello"

The agent's context is automatically loaded via gptme.toml which configures the files and context command to include.

Verified end-to-end

This quickstart was executed end-to-end against gptme 0.33.0 on 2026-09-18. The
gptme-agent create step clones the template, customizes the agent name, and
leaves a ready-to-run workspace:

🚀 Creating agent workspace: /tmp/qs-test-agent
   Agent name: QsTest
   Mode: template-based

📦 Cloning template from https://github.com/gptme/gptme-agent-template...
   Branch: master
✓ Template cloned and customized

✅ Workspace created!

gptme-agent doctor confirms the workspace is ready (23 checks passed, 7
warnings, 1 error — the error is the missing origin remote on a fresh clone,
which is expected until you create a GitHub repository, add it as origin
(git remote add origin [email protected]:YOU/my-agent.git), and push):

Summary: 23 passed, 7 warnings, 1 errors

And gptme "hello" loads the agent's context and completes a turn (output
abridged — the assistant reply appears between the lesson header and the session
stats):

Lessons: 4 unique lessons included (4 total matches)

Hello! I'm QsTest, your AI agent. How can I help you today?

· Session: $0.01 | 3 turns | 22k context | 35% cached
Goodbye! (resume with: gptme --name autonomous-b659)

From pipx install gptme to a responding agent is under five minutes.

One Agent, Multiple Runtimes

Your agent is the workspace, not the harness. Identity, memory, tasks,
lessons, journal, workflow, and audit history live in this version-controlled
repository. A harness is one runtime that can operate on that durable state.

Keep these layers separate when configuring or comparing an agent:

These layers are orthogonal, but they are not a full Cartesian product: each
harness supports a different set of models and access methods. The table below
states exactly what this template ships and where an external adapter is still
required.

The compatibility level is the important claim. “Can read the repository” is
not the same as “ships a reliable autonomous adapter.”

Shipped Alternative: Claude Code

The template also supports Claude Code as an alternative backend:

# Install Claude Code
npm install -g @anthropic-ai/claude-code

# Authenticate
claude /login

# Run interactively (reads AGENTS.md automatically)
claude

# Run autonomously
./scripts/runs/autonomous/autonomous-run-cc.sh

The scripts/build-system-prompt.sh script reads gptme.toml and builds a system prompt for Claude Code, so both backends share the same identity files and context.

Workspace Health Check

After creating or forking an agent workspace, verify everything is configured correctly:

gptme-agent doctor

This checks core files, configuration, directories, tools, and submodules. Use --fix to auto-fix simple issues (create missing directories, initialize submodules).

Requires gptme >= v0.32

Run the agent interactively with gptme or Claude Code:

gptme "hello"
# or: claude

Autonomous Operation

Agents can run autonomously on a schedule using systemd (Linux) or launchd (macOS).

# Install as a system service (runs every 30 minutes by default)
gptme-agent install

# Customize the schedule
gptme-agent install --schedule "*:00"    # Every hour

# Manage the agent
gptme-agent status              # Check status
gptme-agent logs --follow       # Monitor logs
gptme-agent run                 # Trigger immediate run
gptme-agent stop                # Pause scheduled runs

See the gptme agents documentation for service installation and management commands.

To customize the autonomous behavior, edit the run script for your backend:

• gptme: scripts/runs/autonomous/autonomous-run.sh
• Claude Code: scripts/runs/autonomous/autonomous-run-cc.sh

See: scripts/runs/autonomous/README.md for complete documentation.

Features:

• CASCADE workflow (Loose Ends → Task Selection → Execution)
• Two-queue system (manual + generated priorities)
• Safety guardrails (GREEN/YELLOW/RED operation classification)
• Session documentation and state management
• Two shipped autonomous launchers: gptme and Claude Code; other harnesses
  need an adapter that preserves the same workspace contract

Minimal Headless Alternative

If you don't need the full template workspace, gptme ships a built-in CLI to scaffold a bare headless agent (systemd user service + startup script + skeleton gptme.toml/AGENTS.md):

gptme service init --name myagent --model gpt-4o-mini --work-dir ~/gptme-agent

Run gptme service init --help for all options. Fork this template for a full agent workspace; use gptme service init for a minimal one.

Forking (manual alternative)

If you prefer to fork manually instead of using gptme-agent create:

git clone https://github.com/gptme/gptme-agent-template
cd gptme-agent-template
git submodule update --init --recursive

./scripts/fork.sh <path> [<agent-name>]

Then follow the instructions in the output.

Domain Agent Apps

Use knowledge/portable-agent-apps.md
when packaging a domain-specific agent app from this template. The short version:
keep one shared workflow contract, expose it through thin runtime adapters, and
preserve user-owned state across system updates.

Workspace Structure

• gptme-agent keeps track of tasks in TASKS.md
• gptme-agent keeps a journal in ./journal/
• gptme-agent keeps a knowledge base in ./knowledge/

• gptme-agent maintains profiles of people in ./people/

• gptme-agent manages work priorities in ./state/ using the two-queue system (manual + generated)

• gptme-agent uses scripts in ./scripts/ for context generation, task management, and automation
• gptme-agent can add files to gptme.toml to always include them in their context

Key Directories

state/: Work queue management

• queue-manual.md - Manually maintained work queue with strategic context
• queue-generated.md - Auto-generated queue from tasks and GitHub
• See state/README.md for detailed documentation

scripts/: Automation and utilities

• context.sh - Main context generation orchestrator
• gptodo - Task management CLI (install from gptme-contrib)

• runs/autonomous/ - Autonomous operation infrastructure

• See scripts/README.md for complete documentation

lessons/: Behavioral patterns and constraints

• Prevents known failure modes through structured guidance
• See lessons/README.md for lesson system documentation