> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Create and validate your first OpenGAP-compliant agent in 10 minutes.

This quickstart uses [GitAgent](../gitagent/quickstart) as the runtime to run an OpenGAP agent. You can use any OpenGAP-compliant runtime.

## Prerequisites

* Python 3.9+
* pip

## Step 1: Install GitAgent (reference runtime)

```bash theme={null}
pip install gitagent
```

## Step 2: Initialize an OpenGAP agent

```bash theme={null}
mkdir my-opengap-agent && cd my-opengap-agent
git init
gitagent init
```

This creates a compliant directory structure:

```
my-opengap-agent/
├── agent.yaml          ← required
├── skills/
│   └── hello.py
├── hooks/
├── flows/
└── tests/
```

## Step 3: Inspect `agent.yaml`

```yaml theme={null}
opengap: "0.4"          ← spec version declaration
name: my-opengap-agent
version: "1.0.0"
description: "My first OpenGAP agent"

model:
  provider: openai
  name: gpt-4o

skills:
  path: skills/

memory:
  enabled: false
```

The `opengap` field is how runtimes know which spec version to apply.

## Step 4: Validate compliance

```bash theme={null}
gitagent validate
```

Output:

```
✅ agent.yaml: valid (OpenGAP 0.4)
✅ skills/: 1 skill discovered
✅ hooks/: empty (ok)
✅ flows/: empty (ok)
✅ Compliant with OpenGAP 0.4
```

If your agent were missing required fields or using invalid syntax, `gitagent validate` would report exactly what's wrong.

## Step 5: Run the agent

```bash theme={null}
export OPENAI_API_KEY=sk-...
gitagent run "Hello, agent"
```

## Step 6: Try a different runtime

Because the agent is OpenGAP-compliant, any compliant runtime can execute it. For example, deploy to Lyzr Studio:

1. Push your repo to GitHub
2. In Lyzr Studio, go to **Agent Builder → Import from GitHub**
3. Point it at your repo
4. Lyzr reads `agent.yaml` and the `skills/` directory — no additional configuration needed

## What makes an agent OpenGAP-compliant?

At minimum:

* Has `agent.yaml` with `opengap`, `name`, `version`, and `model` fields
* All skills in `skills/` follow the skill contract (Python functions with `@skill` decorator or equivalent JSON schema)
* No undeclared dependencies outside the directory tree
* `gitagent validate` passes with no errors

See [Compliance](./compliance) for the full compliance checklist.