Get Started

This walks you through the complete gitagent setup from zero to running agent. It installs the CLI, scaffolds a project with one of three templates (minimal, standard, or full), and guides you through editing the two required files: agent.yaml for metadata and SOUL.md for personality. Then it validates your setup and shows you how to run locally or share via git URL. The nice thing here is it gets you to a working agent in five commands without making you read documentation first. If someone asks "how do I start with gitagent" in chat, this gives them the actual installation flow instead of just pointing to docs.

GitHub stars: 2.8K
last updated: May 28, 2026

View on GitHub

Install

$ npx -y skills add open-gitagent/opengap --skill get-started --agent claude-code

Installs into .claude/skills of the current project.

Files

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:

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

Edit — Customize agent.yaml (name, description, model) and SOUL.md (identity, personality)
Validate — Check your work:
```
opengap validate -d ./my-agent
```
Run — Launch with Claude:
```
opengap run -d ./my-agent
```

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

SKILL.md on GitHub

Details

Repository: github.com/open-gitagent/opengap
Category: AI & Agent Building
License: MIT
First seen: Jun 11, 2026

More from open-gitagent/opengap

All 18