Quick Start

Install

npm install -g @open-gitagent/opengap

Scaffold & Run

opengap init --template standard   # Scaffold an agent repo
opengap validate                   # Check it's valid
opengap run -d ./my-agent          # Run with Claude Code
opengap run -a github -p "Review"  # Run with GitHub Models
opengap export --format openai     # Export for OpenAI SDK
opengap run -r <repo> -a claude    # Run a remote repo with Claude Code

Templates

Template	Description
`minimal`	2 files: `agent.yaml` + `SOUL.md`
`standard`	Adds skills + tools directories
`full`	Adds compliance, hooks, memory
`llm-wiki`	Knowledge base pattern (Karpathy-style)

First Agent in 3 Steps

# 1. Scaffold
opengap init --template standard
cd my-agent

# 2. Validate
opengap validate

# 3. Run
opengap run -a claude -p "Review the code in src/"

Run from Any Git Repo

Clone any OpenGAP-compatible agent repo and run it instantly: no setup required:

opengap run -r "https://github.com/shreyaskapale/shreyas-agent" -a claude
# → Clones the repo (cached at ~/.gitagent/cache/)
# → Reads agent.yaml + SOUL.md + skills
# → Launches Claude Code with the agent's full identity

Useful flags:

-b develop: run a specific branch
--refresh: force re-clone
--no-cache: clone to temp dir, delete on exit
-p "Review my code": one-shot prompt
-w <dir>: set working directory for the spawned agent process
-a git: auto-detect the right adapter

opengap info shows the resolved config, model, skills, tools, compliance settings, and a SOUL.md preview before you run.

Agent Structure

Understand the full directory layout

agent.yaml Reference

All agent.yaml fields including v0.4 additions

CLI Reference

Full command and flag reference

Adapters

Export targets and framework adapters

Getting Started

Agent Structure

Skills & Workflows

CLI & Adapters

Compliance

FAQ

Quick Start

Install

Scaffold & Run

Templates

First Agent in 3 Steps

Run from Any Git Repo

Agent Structure

agent.yaml Reference

CLI Reference

Adapters

​Install

​Scaffold & Run

​Templates

​First Agent in 3 Steps

​Run from Any Git Repo

Agent Structure

agent.yaml Reference

CLI Reference

Adapters

Install

Scaffold & Run

Templates

First Agent in 3 Steps

Run from Any Git Repo