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.
Get Started with gitagent walks you through installing the CLI and scaffolding your first agent.
AI-generated summary based on this skill's SKILL.md
Install
open-gitagent/opengap/get-started · repository language: TypeScript
git clone https://github.com/open-gitagent/opengap
cp -r opengap/examples/gitagent-helper/skills/get-started ~/.claude/skills/get-startedFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I install gitagent?
gitagent is installed via npm. Run `npm install -g gitagent` to install the CLI globally on your machine. Once installed, you can verify the installation by running `gitagent --version`. This gives you access to all gitagent commands, including the scaffolding tools needed to create your first agent.
How do I create my first agent with gitagent?
gitagent provides scaffolding to jumpstart agent creation. Use the `gitagent init` command to begin setup. You'll be prompted to choose a template—minimal, standard, or full—depending on your needs. The scaffolding generates core files including agent.yaml (configuration) and SOUL.md (agent behavior definition), which you can then customize for your use case.
What templates are available for gitagent agent creation?
gitagent offers three templates to choose from: minimal (bare essentials), standard (recommended for most users), and full (comprehensive setup with advanced features). Each template provides different levels of scaffolding and configuration examples. Select the one that best matches your project scope and experience level.
How do I validate and run a gitagent agent locally?
After creating your agent with gitagent scaffolding, customize agent.yaml and SOUL.md as needed. Then use the gitagent CLI commands to validate your configuration and run the agent locally. This lets you test behavior and settings before deploying to a git repository or production environment.
How can I share my gitagent agent on GitHub?
gitagent agents are designed to be deployed via git repositories. Once your agent is created and validated, initialize a git repository in your agent directory, commit your files (agent.yaml, SOUL.md, and other scaffolded files), and push to GitHub. Others can then clone and run your agent directly from the repository.
What is the gitagent onboarding process for new users?
gitagent's onboarding guides you through installation, template selection, and initial configuration. The process includes running `gitagent init`, choosing your template, customizing core files like agent.yaml and SOUL.md, validating your setup, and running your agent locally. This structured approach helps beginners get productive quickly.
SKILL.md
rendered from the published skill — quoted content, verbatim
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 @open-gitagent/opengap
opengap --version
Create Your First Agent
Walk the user through these steps:
- 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 ```
-
Edit — Customize
agent.yaml(name, description, model) andSOUL.md(identity, personality) -
Validate — Check your work: ```bash opengap validate -d ./my-agent
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 1 file
examples/gitagent-helper/skills/get-started/SKILL.md