|
2 | 2 | <img src="banner.png" alt="gitagent banner" width="700" /> |
3 | 3 | </p> |
4 | 4 |
|
5 | | -# gitagent | your repository becomes your agent |
| 5 | +# GitAgentProtocol (Open GAP) | your repository becomes your agent |
6 | 6 |
|
7 | | -[](https://www.npmjs.com/package/@open-gitagent/gitagent) |
| 7 | +> **`gapman`** — the GitAgentProtocol (GAP) Manager CLI. Previously published as `@open-gitagent/gitagent`. |
| 8 | +
|
| 9 | +[](https://www.npmjs.com/package/gapman) |
8 | 10 | [](https://github.com/open-gitagent/gitagent/actions/workflows/ci.yml) |
9 | 11 | [](https://opensource.org/licenses/MIT) |
10 | 12 | [](https://github.com/open-gitagent/gitagent/blob/main/spec/SPECIFICATION.md) |
11 | 13 | [](https://nodejs.org) |
12 | 14 |
|
13 | | -A framework-agnostic, git-native standard for defining AI agents. Clone a repo, get an agent. |
| 15 | +GitAgentProtocol (Open GAP) is a framework-agnostic, git-native standard for defining AI agents. Clone a repo, get an agent. `gapman` is its reference CLI. |
14 | 16 |
|
15 | 17 | ## Why |
16 | 18 |
|
@@ -236,21 +238,23 @@ See [`examples/nvidia-deep-researcher/`](examples/nvidia-deep-researcher/) for t |
236 | 238 |
|
237 | 239 | ```bash |
238 | 240 | # Install |
239 | | -npm i @open-gitagent/gitagent |
| 241 | +npm i -g gapman |
240 | 242 |
|
241 | 243 | # Create a new agent |
242 | | -gitagent init --template standard |
| 244 | +gapman init --template standard |
243 | 245 |
|
244 | 246 | # Validate |
245 | | -gitagent validate |
| 247 | +gapman validate |
246 | 248 |
|
247 | 249 | # View agent info |
248 | | -gitagent info |
| 250 | +gapman info |
249 | 251 |
|
250 | 252 | # Export to system prompt |
251 | | -gitagent export --format system-prompt |
| 253 | +gapman export --format system-prompt |
252 | 254 | ``` |
253 | 255 |
|
| 256 | +> `gitagent` is installed as an alias — all `gapman <cmd>` calls work as `gitagent <cmd>` too. |
| 257 | +
|
254 | 258 | ## agent.yaml |
255 | 259 |
|
256 | 260 | The only file with a strict schema. Minimal example: |
@@ -300,18 +304,20 @@ compliance: |
300 | 304 |
|
301 | 305 | ## CLI Commands |
302 | 306 |
|
| 307 | +Both `gapman` and `gitagent` refer to the same binary — use whichever you prefer. |
| 308 | + |
303 | 309 | | Command | Description | |
304 | 310 | |---------|-------------| |
305 | | -| `gitagent init [--template]` | Scaffold new agent (`minimal`, `standard`, `full`) | |
306 | | -| `gitagent validate [--compliance]` | Validate against spec and regulatory requirements | |
307 | | -| `gitagent info` | Display agent summary | |
308 | | -| `gitagent export --format <fmt>` | Export to other formats (see adapters below) | |
309 | | -| `gitagent import --from <fmt> <path>` | Import (`claude`, `cursor`, `crewai`, `opencode`) | |
310 | | -| `gitagent run <source> --adapter <a>` | Run an agent from a git repo or local directory | |
311 | | -| `gitagent install` | Resolve and install git-based dependencies | |
312 | | -| `gitagent audit` | Generate compliance audit report | |
313 | | -| `gitagent skills <cmd>` | Manage skills (`search`, `install`, `list`, `info`) | |
314 | | -| `gitagent lyzr <cmd>` | Manage Lyzr agents (`create`, `update`, `info`, `run`) | |
| 311 | +| `gapman init [--template]` | Scaffold new agent (`minimal`, `standard`, `full`, `llm-wiki`) | |
| 312 | +| `gapman validate [--compliance]` | Validate against spec and regulatory requirements | |
| 313 | +| `gapman info` | Display agent summary | |
| 314 | +| `gapman export --format <fmt>` | Export to other formats (see adapters below) | |
| 315 | +| `gapman import --from <fmt> <path>` | Import (`claude`, `cursor`, `crewai`, `opencode`) | |
| 316 | +| `gapman run <source> --adapter <a>` | Run an agent from a git repo or local directory | |
| 317 | +| `gapman install` | Resolve and install git-based dependencies | |
| 318 | +| `gapman audit` | Generate compliance audit report | |
| 319 | +| `gapman skills <cmd>` | Manage skills (`search`, `install`, `list`, `info`) | |
| 320 | +| `gapman lyzr <cmd>` | Manage Lyzr agents (`create`, `update`, `info`, `run`) | |
315 | 321 |
|
316 | 322 | ## Compliance |
317 | 323 |
|
@@ -364,10 +370,10 @@ Adapters are used by both `export` and `run`. Available adapters: |
364 | 370 |
|
365 | 371 | ```bash |
366 | 372 | # Export to system prompt |
367 | | -gitagent export --format system-prompt |
| 373 | +gapman export --format system-prompt |
368 | 374 |
|
369 | 375 | # Run an agent directly |
370 | | -gitagent run ./my-agent --adapter lyzr |
| 376 | +gapman run ./my-agent --adapter lyzr |
371 | 377 | ``` |
372 | 378 |
|
373 | 379 | ## Inheritance & Composition |
|
0 commit comments