---
name: Get Started with GitAgent
slug: get-started-with-gitagent
category: AI Engineering
description: Get Started with GitAgent guides installation of gitagent and creation of a first agent using scaffolding, configuration, and validation. Use when new to gitagent or setting up an initial agent.
github: "https://github.com/open-gitagent/opengap/tree/main/examples/gitagent-helper/skills/get-started"
language: TypeScript
stars: 2916
forks: 346
install: "npx degit https://github.com/open-gitagent/opengap/tree/main/examples/gitagent-helper/skills/get-started ~/.claude/skills/get-started"
installs_to: ~/.claude/skills/get-started
source_path: examples/gitagent-helper/skills/get-started/SKILL.md
collection_size: 18
category_size: 2451
collection_url: "https://dirskills.com/collections/open-gitagent/opengap"
added: 2026-08-17T07:10:03.781Z
last_synced: 2026-08-17T07:10:03.781Z
canonical_url: "https://dirskills.com/skills/get-started-with-gitagent"
---

# Get Started with GitAgent

Get Started with GitAgent guides installation of gitagent and creation of a first agent using scaffolding, configuration, and validation. Use when new to gitagent or setting up an initial agent.

**Install:**

```bash
npx degit https://github.com/open-gitagent/opengap/tree/main/examples/gitagent-helper/skills/get-started ~/.claude/skills/get-started
```

## README

# 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