Skill2.8k repo starsupdated 16d 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

More from this repository

document-reviewSkill

Reviews financial documents (prospectuses, ADVs, marketing materials) for FINRA 2210 compliance, required disclosures, and balanced presentation. Use when reviewing financial statements, audit documents, regulatory filings, or when the user mentions compliance checks, financial audits, or document verification.

regulatory-analysisSkill

Analyzes documents and processes against FINRA, SEC, Federal Reserve, and CFPB regulatory frameworks. Identifies compliance gaps, classifies findings by severity, and recommends remediation. Use when performing compliance audits, regulatory reviews, gap analyses, or verifying policy adherence to financial regulations.

create-agentSkill

Creates and configures agent.yaml files, writes SOUL.md personality definitions, and sets up agent directory structures with skills, tools, and knowledge. Use when the user wants to configure an agent, create agent.yaml, write SOUL.md, set up agent directory structure, or customize agent settings.

export-agentSkill

Converts agent definitions between frameworks — exports to Claude Code, OpenAI, CrewAI, Lyzr, and GitHub Models formats, and imports from Claude, Cursor, and CrewAI projects. Use when the user wants to convert an agent, migrate to another framework, export to LangChain/AutoGen/CrewAI, or import from existing automation tools.

manage-skillsSkill

Searches the SkillsMP registry, installs skills locally or globally, creates custom skills with SKILL.md frontmatter, and manages the skill lifecycle. Use when the user wants to find skills, add new capabilities, install a skill, browse available skills, create a custom skill, or manage the skills system.

run-agentSkill

Configures and runs agents with different adapters including Claude, OpenAI, CrewAI, Lyzr, and GitHub Models. Supports local execution, remote git repos, and one-shot prompts. Use when the user wants to run an agent, switch LLM providers, configure adapter settings, or launch agents from git repositories.

compute-ladderSkill

narco-checkSkill