How do I start with gitagent?

Install the CLI globally (npm install -g gitagent), verify the version, then scaffold your first agent with gitagent init using a template, and proceed to edit files.

What do the templates do?

Minimal creates 2 files, Standard adds skills/tools/knowledge, and Full includes compliance, hooks, memory, and workflows.

How do I share my agent?

Push the agent to Git and run it remotely with gitagent run -r so others can execute it from the shared repository.

get-started

npx machina-cli add skill open-gitagent/gitagent/get-started --openclaw

Files (1)

SKILL.md

1.4 KB

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 gitagent
gitagent --version

Create Your First Agent

Walk the user through these steps:

Scaffold — Pick a template:

# Minimal (2 files)
gitagent init --template minimal --dir ./my-agent

# Standard (with skills, tools, knowledge)
gitagent init --template standard --dir ./my-agent

# Full (compliance, hooks, memory, workflows)
gitagent init --template full --dir ./my-agent

Edit — Customize agent.yaml (name, description, model) and SOUL.md (identity, personality)
Validate — Check your work:
```
gitagent validate -d ./my-agent
```
Run — Launch with Claude:
```
gitagent 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:
gitagent 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

Source

git clone https://github.com/open-gitagent/gitagent/blob/main/examples/gitagent-helper/skills/get-started/SKILL.mdView on GitHub

Overview

This skill guides new users to install gitagent globally, scaffold their first agent from templates (minimal, standard, full), and tailor key files. It then covers validation, running, and sharing the agent via Git, using agent.yaml and SOUL.md for identity and capabilities.

How This Skill Works

Install the gitagent CLI globally, then scaffold your agent with gitagent init using a chosen template. Edit agent.yaml and SOUL.md to define identity and personality, validate your setup with gitagent validate, run it locally with gitagent run (Claude), and finally share the repo so others can run it using a remote URL.

When to Use It

You are new to gitagent and want to create your first agent from scratch.
You need to choose a scaffold template: minimal, standard, or full.
You want to verify that agent.yaml and SOUL.md are properly configured before running.
You plan to run your agent locally with Claude for testing.
You want to share or deploy your agent by pushing to Git and running from a remote URL.

Quick Start

Step 1: Install - npm install -g gitagent and verify with gitagent --version
Step 2: Scaffold - gitagent init --template standard --dir ./my-agent (choose minimal, standard, or full)
Step 3: Edit + Validate + Run - edit agent.yaml and SOUL.md, then gitagent validate -d ./my-agent and gitagent run -d ./my-agent

Best Practices

Install gitagent globally and verify the installation before scaffolding.
Choose the template that matches your needs: minimal for basics, standard for included skills/tools, full for compliance and workflows.
Edit agent.yaml (name, description, model) and SOUL.md (identity, personality) to reflect your agent accurately.
Keep the repository clean by including only required files initially (agent.yaml, SOUL.md) and documenting others as needed.
Always run gitagent validate -d ./my-agent before gitagent run to catch configuration issues early.

Example Use Cases

Onboard a new teammate by creating a starter agent from the standard template and customizing its identity.
Prototype a customer-support agent using the minimal template to test basic interactions.
Create a compliance-ready agent with the full template, including hooks and memory for audit trails.
Develop an internal knowledge agent by configuring SOUL.md for organizational tone and behavior.
Share a working agent via Git and deploy it remotely with gitagent run -r https://github.com/you/my-agent.

Frequently Asked Questions

Add this skill to your agents