Get Started

Get Started with gitagent

When to Use

When a user is new to gitagent, wants to set up their first agent, or asks "how do I start?"

Instructions

Installation

npm install -g @open-gitagent/opengap
opengap --version

Create Your First Agent

Walk the user through these steps:

1. Scaffold — Pick a template:

   # Minimal (2 files)
   opengap init --template minimal --dir ./my-agent
   
   # Standard (with skills, tools, knowledge)
   opengap init --template standard --dir ./my-agent
   
   # Full (compliance, hooks, memory, workflows)
   opengap init --template full --dir ./my-agent
   

2. Edit — Customize agent.yaml (name, description, model) and SOUL.md (identity, personality)

3. Validate — Check your work:

   opengap validate -d ./my-agent
   

4. Run — Launch with Claude:

   opengap run -d ./my-agent
   

5. Share — Push to git and anyone can run it:

   cd my-agent && git init && git add . && git commit -m "Initial agent"
   # Push to GitHub, then:
   opengap run -r https://github.com/you/my-agent
   

Minimum Required Files

• agent.yaml — name, version, description (required)
• SOUL.md — agent identity (required)
• Everything else is optional