Skip to content

Commit 5ffc84d

Browse files
authored
chore: rebrand gapman → opengap (package, CLI, docs) (#82)
Renames the package and CLI to OpenGAP and updates all documentation. - package.json: name @open-gitagent/gapman → @open-gitagent/opengap, bin gapman → opengap (gitagent alias kept), version 0.3.2 → 0.4.0, description + keywords updated - package-lock.json: name/version/bin updated - src/index.ts: CLI self-name gapman → opengap, version 0.4.0 - src/commands/registry.ts: npx @open-gitagent/opengap - .github/workflows/publish.yml: publishes @open-gitagent/opengap (scoped) + opengap (unscoped alias) - 274 doc edits across README, docs.md, CONTRIBUTING, spec, examples, paper: all 'gapman <verb>' CLI examples → 'opengap <verb>', npm install lines, inline code names - Historical migration notes in README/docs preserved (gitagent → gapman → opengap chain) so existing gapman users can find the new package - gitagent command remains installed as a backward-compat alias
1 parent b3a057a commit 5ffc84d

26 files changed

Lines changed: 282 additions & 281 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A clear and concise description of the bug.
1212
## Environment
1313
- **OS**: (e.g., macOS 14, Ubuntu 22.04, Windows 11)
1414
- **Node.js version**: (e.g., 18.19.0)
15-
- **gapman version**: (run `gapman --version`)
15+
- **opengap version**: (run `opengap --version`)
1616
- **Adapter** (if applicable): (e.g., claude-code, openai, crewai)
1717

1818
## Steps to Reproduce

.github/workflows/publish.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ jobs:
2323
- run: npm run build
2424
- run: npm test
2525

26-
- name: Publish @open-gitagent/gapman (scoped)
26+
- name: Publish @open-gitagent/opengap (scoped)
2727
run: npm publish --provenance --access public
2828
env:
2929
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
3030

31-
- name: Publish gapman (unscoped alias)
31+
- name: Publish opengap (unscoped alias)
3232
run: |
33-
node -e "const fs=require('fs');const p=JSON.parse(fs.readFileSync('package.json','utf8'));p.name='gapman';fs.writeFileSync('package.json',JSON.stringify(p,null,2));"
33+
node -e "const fs=require('fs');const p=JSON.parse(fs.readFileSync('package.json','utf8'));p.name='opengap';fs.writeFileSync('package.json',JSON.stringify(p,null,2));"
3434
npm publish --provenance --access public
3535
env:
3636
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ Recompiles on file changes. You still need to re-run the command manually.
5555
src/
5656
├── index.ts # CLI entry point (Commander.js)
5757
├── commands/ # One file per CLI command
58-
│ ├── run.ts # gapman run
59-
│ ├── init.ts # gapman init
60-
│ ├── validate.ts # gapman validate
61-
│ ├── export.ts # gapman export
62-
│ ├── import.ts # gapman import
63-
│ ├── audit.ts # gapman audit
64-
│ ├── skills.ts # gapman skills
65-
│ ├── install.ts # gapman install
66-
│ ├── info.ts # gapman info
67-
│ └── lyzr.ts # gapman lyzr
58+
│ ├── run.ts # opengap run
59+
│ ├── init.ts # opengap init
60+
│ ├── validate.ts # opengap validate
61+
│ ├── export.ts # opengap export
62+
│ ├── import.ts # opengap import
63+
│ ├── audit.ts # opengap audit
64+
│ ├── skills.ts # opengap skills
65+
│ ├── install.ts # opengap install
66+
│ ├── info.ts # opengap info
67+
│ └── lyzr.ts # opengap lyzr
6868
├── runners/ # Runtime adapters (execute agents)
6969
│ ├── claude.ts # Claude Code runner
7070
│ ├── openai.ts # OpenAI Agents SDK runner

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
<img src="banner.png" alt="gitagent banner" width="700" />
33
</p>
44

5-
# GitAgentProtocol (Open GAP) | your repository becomes your agent
5+
# OpenGAP | your repository becomes your agent
66

7-
> **`gapman`** — the GitAgentProtocol (GAP) Manager CLI, published as [`@open-gitagent/gapman`](https://www.npmjs.com/package/@open-gitagent/gapman). Previously published as `@open-gitagent/gitagent`.
7+
> **`opengap`** — the OpenGAP CLI, published as [`@open-gitagent/opengap`](https://www.npmjs.com/package/@open-gitagent/opengap). Previously published as `@open-gitagent/gapman` and originally `@open-gitagent/gitagent`; the `gitagent` command is still installed as an alias for backward compatibility.
88
9-
[![npm version](https://img.shields.io/npm/v/@open-gitagent/gapman)](https://www.npmjs.com/package/@open-gitagent/gapman)
9+
[![npm version](https://img.shields.io/npm/v/@open-gitagent/opengap)](https://www.npmjs.com/package/@open-gitagent/opengap)
1010
[![CI](https://github.com/open-gitagent/gitagent/actions/workflows/ci.yml/badge.svg)](https://github.com/open-gitagent/gitagent/actions/workflows/ci.yml)
1111
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
1212
[![Spec: v0.1.0](https://img.shields.io/badge/spec-v0.1.0-blue)](https://github.com/open-gitagent/gitagent/blob/main/spec/SPECIFICATION.md)
1313
[![Node >= 18](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
1414

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.
15+
OpenGAP (the Git Agent Protocol) is a framework-agnostic, git-native standard for defining AI agents. Clone a repo, get an agent. `opengap` is its reference CLI.
1616

1717
## Why
1818

@@ -136,7 +136,7 @@ Fork any public agent repo, customize its `SOUL.md`, add your own skills, and PR
136136
<img src="patterns/agent-forking.png" alt="Agent Forking & Remixing" width="600" />
137137

138138
### CI/CD for Agents
139-
Run `gapman validate` on every push via GitHub Actions. Test agent behavior in CI, block bad merges, and auto-deploy — treat agent quality like code quality.
139+
Run `opengap validate` on every push via GitHub Actions. Test agent behavior in CI, block bad merges, and auto-deploy — treat agent quality like code quality.
140140

141141
<img src="patterns/ci-cd-agents.png" alt="CI/CD for Agents" width="600" />
142142

@@ -216,7 +216,7 @@ This pattern is demonstrated with [NVIDIA's AIQ Deep Researcher](https://github.
216216

217217
- **Fork for a new domain** — edit `SOUL.md` for legal/medical/finance research without touching Python
218218
- **Version prompts independently** — `git diff` when the orchestrator's style regresses
219-
- **Validate SOD** — `gapman validate --compliance` ensures the orchestrator can't also be the researcher
219+
- **Validate SOD** — `opengap validate --compliance` ensures the orchestrator can't also be the researcher
220220
- **Export to other runtimes** — same identity on Claude Code, OpenAI, or as a raw system prompt
221221

222222
```
@@ -238,22 +238,22 @@ See [`examples/nvidia-deep-researcher/`](examples/nvidia-deep-researcher/) for t
238238
239239
```bash
240240
# Install
241-
npm i -g @open-gitagent/gapman
241+
npm i -g @open-gitagent/opengap
242242
243243
# Create a new agent
244-
gapman init --template standard
244+
opengap init --template standard
245245
246246
# Validate
247-
gapman validate
247+
opengap validate
248248
249249
# View agent info
250-
gapman info
250+
opengap info
251251
252252
# Export to system prompt
253-
gapman export --format system-prompt
253+
opengap export --format system-prompt
254254
```
255255

256-
> `gitagent` is installed as an alias — all `gapman <cmd>` calls work as `gitagent <cmd>` too.
256+
> `gitagent` is installed as an alias — all `opengap <cmd>` calls work as `gitagent <cmd>` too.
257257
258258
## agent.yaml
259259

@@ -304,20 +304,20 @@ compliance:
304304
305305
## CLI Commands
306306
307-
Both `gapman` and `gitagent` refer to the same binary — use whichever you prefer.
307+
Both `opengap` and `gitagent` refer to the same binary — use whichever you prefer.
308308

309309
| Command | Description |
310310
|---------|-------------|
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`) |
311+
| `opengap init [--template]` | Scaffold new agent (`minimal`, `standard`, `full`, `llm-wiki`) |
312+
| `opengap validate [--compliance]` | Validate against spec and regulatory requirements |
313+
| `opengap info` | Display agent summary |
314+
| `opengap export --format <fmt>` | Export to other formats (see adapters below) |
315+
| `opengap import --from <fmt> <path>` | Import (`claude`, `cursor`, `crewai`, `opencode`) |
316+
| `opengap run <source> --adapter <a>` | Run an agent from a git repo or local directory |
317+
| `opengap install` | Resolve and install git-based dependencies |
318+
| `opengap audit` | Generate compliance audit report |
319+
| `opengap skills <cmd>` | Manage skills (`search`, `install`, `list`, `info`) |
320+
| `opengap lyzr <cmd>` | Manage Lyzr agents (`create`, `update`, `info`, `run`) |
321321

322322
## Compliance
323323

@@ -347,7 +347,7 @@ gitagent has first-class support for financial regulatory compliance:
347347

348348
Inspired by [Salient AI](https://www.trysalient.com/)'s purpose-built agent architecture and the [FINOS AI Governance Framework](https://air-governance-framework.finos.org/mitigations/mi-22_multi-agent-isolation-and-segmentation.html).
349349

350-
Run `gapman audit` for a full compliance checklist against your agent configuration.
350+
Run `opengap audit` for a full compliance checklist against your agent configuration.
351351

352352
## Adapters
353353

@@ -374,13 +374,13 @@ Adapters are used by both `export` and `run`. Available adapters:
374374

375375
```bash
376376
# Export to system prompt
377-
gapman export --format system-prompt
377+
opengap export --format system-prompt
378378
379379
# Run an agent directly
380-
gapman run ./my-agent --adapter lyzr
380+
opengap run ./my-agent --adapter lyzr
381381
382382
# Run an agent definition against a separate target workspace
383-
gapman run --dir ./agents/reviewer --workspace ~/code/my-app --adapter claude -p "Review this repository"
383+
opengap run --dir ./agents/reviewer --workspace ~/code/my-app --adapter claude -p "Review this repository"
384384
```
385385

386386
## Inheritance & Composition

0 commit comments

Comments
 (0)