Skill3k repo starsupdated 3mo ago

get-started

This skill guides new users through installing gitagent via npm, scaffolding their first agent from templates, and validating their setup. Use it when users are unfamiliar with gitagent, request installation instructions, want to create their initial agent, or ask how to begin with the framework.

View source Repository: opengap

Install in Claude Code

Copy

git clone --depth 1 https://github.com/open-gitagent/opengap /tmp/get-started && cp -r /tmp/get-started/examples/gitagent-helper/skills/get-started ~/.claude/skills/get-started

Then start a new Claude Code session; the skill loads automatically.

Definition

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