---
id: open-gitagent/opengap/get-started
version: "884b544c"
license: MIT
install: manual
updated: 2026-07-02
---

# get-started — This skill guides you through installing the gitagent CLI and creating your first agent from a template. You'll customize core files like agent.yaml and SOUL.md, validate your setup, and run your agent locally or from a git repository.

Publisher: open-gitagent · Stars: 2903 · Updated: 2026-07-02

Install (manual): `git clone https://github.com/open-gitagent/opengap`

## SKILL.md

# 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
```bash
npm install -g @open-gitagent/opengap
opengap --version
```

### Create Your First Agent
Walk the user through these steps:

1. **Scaffold** — Pick a template:
   ```bash
   # 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:
   ```bash
   opengap validate -d ./my-agent
   ```

4. **Run** — Launch with Claude:
   ```bash
   opengap run -d ./my-agent
   ```

5. **Share** — Push to git and anyone can run it:
   ```bash
   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


[View on SkillFed](https://skillfed.io/open-gitagent/opengap/get-started) · [View on GitHub](https://github.com/open-gitagent/opengap)