Gitagent get-started

Guides installation of gitagent and creation of first agent with scaffolding, configuration, and validation. Use when the user is new to gitagent, asks how to get started, wants to install gitagent, set up their first agent, or says 'how do I start?'

install
source · Clone the upstream repo
git clone https://github.com/open-gitagent/gitagent
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/open-gitagent/gitagent "$T" && mkdir -p ~/.claude/skills && cp -r "$T/examples/gitagent-helper/skills/get-started" ~/.claude/skills/open-gitagent-gitagent-get-started && rm -rf "$T"
manifest: examples/gitagent-helper/skills/get-started/SKILL.md
source content

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/gapman
gapman --version

Create Your First Agent

Walk the user through these steps:

  1. Scaffold — Pick a template:

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

    agent.yaml
    (name, description, model) and
    SOUL.md
    (identity, personality)

  3. Validate — Check your work:

    gitagent validate -d ./my-agent
    
  4. Run — Launch with Claude:

    gitagent 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:
    gitagent 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