Skip to content

Commit 4eb0be1

Browse files
NagyViktNagyVikt
andauthored
Align the published package name with the GitGuardex brand (#262)
Rename package metadata and install/update surfaces to @imdeadpool/gitguardex while keeping gx preferred and guardex as a legacy alias. Refresh docs, tutorial assets, and OpenSpec scaffolding to point at the renamed package, and keep historical release notes tied to the package scope that was actually published at each version. Constraint: Existing gx and guardex entry points must keep working during the package-name transition Rejected: Drop the guardex bin alias now | would break existing shells and automation during the rename Rejected: Rewrite historical release entries to the new npm scope | inaccurate because older releases shipped as @imdeadpool/guardex Confidence: high Scope-risk: moderate Reversibility: clean Directive: Keep historical release-note package references aligned with the package name that was actually published at that version Tested: node --test --test-name-pattern "(self-update verifies on-disk version after @latest install and retries with pinned version when stale|self-update restarts into the installed CLI after a successful on-disk upgrade|status --json returns cli, services, and repo summary|prompt outputs AI setup instructions|prompt --exec outputs command-only checklist|deprecated copy-commands alias still works and warns)" test/install.test.js Tested: node --check bin/multiagent-safety.js Tested: npm pack --dry-run Tested: openspec validate agent-codex-rename-npm-package-to-gitguardex-everywh-2026-04-21-21-02 --type change --strict Tested: openspec validate --specs Not-tested: full node --test test/install.test.js still hangs in an unrelated gx setup path in this repo Co-authored-by: NagyVikt <nagy.viktordp@gmail.com>
1 parent 569c307 commit 4eb0be1

21 files changed

Lines changed: 177 additions & 112 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Thanks for contributing to `GuardeX`.
3+
Thanks for contributing to `GitGuardex`.
44

55
## Development setup
66

README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# GitGuardex — Guardian T-Rex for your repo
22

3-
[![npm version](https://img.shields.io/npm/v/%40imdeadpool%2Fguardex?label=npm&color=cb3837&logo=npm)](https://www.npmjs.com/package/@imdeadpool/guardex)
4-
[![npm downloads](https://img.shields.io/npm/dm/%40imdeadpool%2Fguardex?label=downloads&color=0b76c5)](https://www.npmjs.com/package/@imdeadpool/guardex)
3+
[![npm version](https://img.shields.io/npm/v/%40imdeadpool%2Fgitguardex?label=npm&color=cb3837&logo=npm)](https://www.npmjs.com/package/@imdeadpool/gitguardex)
4+
[![npm downloads](https://img.shields.io/npm/dm/%40imdeadpool%2Fgitguardex?label=downloads&color=0b76c5)](https://www.npmjs.com/package/@imdeadpool/gitguardex)
55
[![GitHub stars](https://img.shields.io/github/stars/recodeee/gitguardex?label=stars&color=d4ac0d)](https://github.com/recodeee/gitguardex/stargazers)
6-
[![License](https://img.shields.io/npm/l/%40imdeadpool%2Fguardex?label=License&color=97ca00)](./LICENSE)
6+
[![License](https://img.shields.io/npm/l/%40imdeadpool%2Fgitguardex?label=License&color=97ca00)](./LICENSE)
77

88
[![CI](https://img.shields.io/github/actions/workflow/status/recodeee/gitguardex/ci.yml?branch=main&label=CI)](https://github.com/recodeee/gitguardex/actions/workflows/ci.yml)
99
[![Release](https://img.shields.io/github/actions/workflow/status/recodeee/gitguardex/release.yml?label=Release)](https://github.com/recodeee/gitguardex/actions/workflows/release.yml)
@@ -38,7 +38,7 @@ GitGuardex exists to stop that loop. Every agent gets its own worktree, claims t
3838
<h3 align="center">Install in one line</h3>
3939

4040
```bash
41-
npm i -g @imdeadpool/guardex
41+
npm i -g @imdeadpool/gitguardex
4242
```
4343

4444
<p align="center">
@@ -49,8 +49,8 @@ npm i -g @imdeadpool/guardex
4949
</p>
5050

5151
<p align="center">
52-
<a href="https://www.npmjs.com/package/@imdeadpool/guardex"><img alt="npm" src="https://img.shields.io/npm/v/%40imdeadpool%2Fguardex?label=latest&style=flat-square&color=cb3837&logo=npm&logoColor=white"></a>
53-
<a href="https://www.npmjs.com/package/@imdeadpool/guardex"><img alt="downloads" src="https://img.shields.io/npm/dm/%40imdeadpool%2Fguardex?label=downloads&style=flat-square&color=0b76c5"></a>
52+
<a href="https://www.npmjs.com/package/@imdeadpool/gitguardex"><img alt="npm" src="https://img.shields.io/npm/v/%40imdeadpool%2Fgitguardex?label=latest&style=flat-square&color=cb3837&logo=npm&logoColor=white"></a>
53+
<a href="https://www.npmjs.com/package/@imdeadpool/gitguardex"><img alt="downloads" src="https://img.shields.io/npm/dm/%40imdeadpool%2Fgitguardex?label=downloads&style=flat-square&color=0b76c5"></a>
5454
<a href="https://github.com/recodeee/gitguardex/stargazers"><img alt="stars" src="https://img.shields.io/github/stars/recodeee/gitguardex?style=flat-square&color=d4ac0d"></a>
5555
</p>
5656

@@ -70,19 +70,19 @@ Coming soon: [recodee.com](https://recodee.com) — live account health, usage,
7070
- **Protected-base safety**`main`, `dev`, `master` are blocked by default; agents must go through PRs.
7171
- **Auto-merges agent configs into every worktree**`oh-my-codex`, `oh-my-claudecode`, caveman mode, and OpenSpec all get applied automatically so every spawned agent starts tuned, not bare.
7272
- **Repair/doctor flow** — when drift happens (and it will), `gx doctor` gets you back to a clean state.
73-
- **Auto-finish** — when Codex exits a session, Guardex commits sandbox changes, syncs against the base, retries once if the base moved, and opens a PR.
73+
- **Auto-finish** — when Codex exits a session, GitGuardex commits sandbox changes, syncs against the base, retries once if the base moved, and opens a PR.
7474

7575
---
7676

7777
## Quick start
7878

7979
```sh
80-
npm i -g @imdeadpool/guardex
80+
npm i -g @imdeadpool/gitguardex
8181
cd /path/to/your/repo
8282
gx setup
8383
```
8484

85-
That's it. Setup installs hooks, scripts, templates, and scaffolds OpenSpec/caveman/OMX wiring. Aliases: `gx` (preferred), `gitguardex` (full), `guardex` (legacy).
85+
That's it. New installs should use `@imdeadpool/gitguardex` so the published package matches the GitGuardex name. Setup installs hooks, scripts, templates, and scaffolds OpenSpec/caveman/OMX wiring. Aliases: `gx` (preferred), `gitguardex` (full), `guardex` (legacy compatibility).
8686

8787
---
8888

@@ -199,7 +199,7 @@ bash scripts/agent-branch-finish.sh \
199199

200200
If you use `scripts/codex-agent.sh`, the finish flow runs automatically when the Codex session exits — it auto-commits, retries once after syncing if the base moved during the run, then pushes and opens the PR.
201201

202-
Guardex normally prunes merged sandboxes for you as part of the finish flow. If you simply do not want a local sandbox/worktree anymore, remove that worktree directly; delete the branch too only if you are intentionally abandoning that lane:
202+
GitGuardex normally prunes merged sandboxes for you as part of the finish flow. If you simply do not want a local sandbox/worktree anymore, remove that worktree directly; delete the branch too only if you are intentionally abandoning that lane:
203203

204204
```sh
205205
git worktree remove .omx/agent-worktrees/<worktree-name>
@@ -229,11 +229,11 @@ Codex sessions default to `.omx/agent-worktrees/`. Claude Code sessions default
229229

230230
### How It Works In VS Code
231231

232-
This is the real Source Control shape Guardex is aiming for: isolated agent branches, clear OpenSpec artifacts, and no pile-up on one shared checkout.
232+
This is the real Source Control shape GitGuardex is aiming for: isolated agent branches, clear OpenSpec artifacts, and no pile-up on one shared checkout.
233233

234234
![Guarded VS Code Source Control example](https://raw.githubusercontent.com/recodeee/gitguardex/main/docs/images/workflow-source-control-grouped.png)
235235

236-
To install the real companion into local VS Code from a Guardex-wired repo:
236+
To install the real companion into local VS Code from a GitGuardex-wired repo:
237237

238238
```sh
239239
node scripts/install-vscode-active-agents-extension.js
@@ -406,7 +406,7 @@ GitGuardex is designed to work alongside these. All optional — but if you're r
406406

407407
### oh-my-codex — Codex config + skills framework
408408

409-
Loads skills, slash commands, and session defaults into Codex. Guardex merges `oh-my-codex` into every agent worktree automatically, so every spawned agent starts with the same tuned config instead of vanilla Codex.
409+
Loads skills, slash commands, and session defaults into Codex. GitGuardex merges `oh-my-codex` into every agent worktree automatically, so every spawned agent starts with the same tuned config instead of vanilla Codex.
410410

411411
```sh
412412
npm i -g oh-my-codex
@@ -417,7 +417,7 @@ Repo: <https://github.com/Yeachan-Heo/oh-my-codex>
417417

418418
### oh-my-claudecode — Claude Code equivalent
419419

420-
Claude-side mirror of oh-my-codex. Same idea: skills, commands, and defaults loaded into every Claude Code session. Guardex merges it into worktrees alongside oh-my-codex so mixed Codex + Claude agent fleets behave consistently. For the npm CLI/runtime path, the published package name is `oh-my-claude-sisyphus`.
420+
Claude-side mirror of oh-my-codex. Same idea: skills, commands, and defaults loaded into every Claude Code session. GitGuardex merges it into worktrees alongside oh-my-codex so mixed Codex + Claude agent fleets behave consistently. For the npm CLI/runtime path, the published package name is `oh-my-claude-sisyphus`.
421421

422422
```sh
423423
npm i -g oh-my-claude-sisyphus@latest
@@ -636,10 +636,11 @@ npm pack --dry-run
636636
<summary><strong>v7.x</strong></summary>
637637

638638
### v7.0.16
639+
- GitGuardex now publishes under the matching npm package name `@imdeadpool/gitguardex`, and install/help/docs surfaces point at the renamed package instead of the older `@imdeadpool/guardex` scope.
639640
- `gx doctor` now keeps nested repo repair runs visibly progressing, and overlapping integration work stays off the protected base branch instead of trying to merge back on `main`.
640641
- Cleanup and finish flows are less brittle: `codex-agent` no longer waits on PRs that can never exist, and prune cleanup now walks both managed worktree roots so stale sandboxes get removed consistently.
641-
- Mirror-sync diagnostics are quieter: when the mirror PAT is unset, Guardex now skips the sync path instead of marking the run red, and shared `ralplan` lanes stay easier to identify during handoff/debugging.
642-
- Bumped `@imdeadpool/guardex` from `7.0.15``7.0.16` after npm rejected a republish over the already-published `7.0.15`.
642+
- Mirror-sync diagnostics are quieter: when the mirror PAT is unset, GitGuardex now skips the sync path instead of marking the run red, and shared `ralplan` lanes stay easier to identify during handoff/debugging.
643+
- Bumped the release from `7.0.15``7.0.16` after npm rejected a republish of `7.0.15`.
643644

644645
### v7.0.15
645646
- `gx doctor` no longer blocks recursive nested protected-repo repairs on child PR merge waits; nested sandboxes now force `--no-wait-for-merge` so the parent repair loop can continue.
@@ -652,7 +653,7 @@ npm pack --dry-run
652653

653654
### v7.0.13
654655
- `gx status` and `gx setup` now present the Claude companion as `oh-my-claudecode` while still installing the published npm package `oh-my-claude-sisyphus`.
655-
- When that dependency is inactive or the user declines the optional install, Guardex now prints the upstream repo URL so the missing dependency is explicit instead of hidden behind the npm package name.
656+
- When that dependency is inactive or the user declines the optional install, GitGuardex now prints the upstream repo URL so the missing dependency is explicit instead of hidden behind the npm package name.
656657
- Bumped `@imdeadpool/guardex` from `7.0.12``7.0.13` after npm rejected a republish over the already-published `7.0.12`.
657658

658659
### v7.0.12
@@ -710,8 +711,8 @@ npm pack --dry-run
710711
- **Breaking (soft).** Consolidated 17 commands into 12 visible commands with flag-based subcommands. Removed names still work but print a deprecation notice; will be removed in v8.
711712
- **Token-usage improvements.** Trimmed auto-installed agent templates that live in every consumer repo and get loaded into every session:
712713
- `templates/AGENTS.multiagent-safety.md`: 6990 B → 1615 B (−77%)
713-
- `templates/codex/skills/guardex/SKILL.md`: 2732 B → 1086 B (−60%)
714-
- `templates/claude/commands/guardex.md`: 472 B → 357 B (−24%)
714+
- `templates/codex/skills/gitguardex/SKILL.md`: 2732 B → 1086 B (−60%)
715+
- `templates/claude/commands/gitguardex.md`: 472 B → 357 B (−24%)
715716
- Total: 10194 B → 3058 B per consumer repo (−70%, ~1.5k fewer tokens per agent session).
716717
- New `gx prompt` command replaces three prompt-emitting commands.
717718
- New flag surface on `gx setup`: `--install-only`, `--repair`.
@@ -752,7 +753,7 @@ Version bumps for npm publish continuity plus incremental fixes: doctor arg-pars
752753
- Allows tightly guarded Codex-only commits for `AGENTS.md` / `.gitignore` on protected branches.
753754

754755
### v5.0.0
755-
- Rebranded CLI to **GuardeX** with `gx`-first command UX.
756+
- Rebranded CLI to **GitGuardex** with `gx`-first command UX.
756757
- Published under scoped package name `@imdeadpool/guardex`.
757758
- Enforced repeatable per-message agent branch lifecycle in setup/init flows.
758759
- Added codex-auth-aware sandbox branch naming support.

bin/multiagent-safety.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
1111
const TOOL_NAME = 'gitguardex';
1212
const SHORT_TOOL_NAME = 'gx';
1313
const LEGACY_NAMES = ['guardex', 'multiagent-safety'];
14+
const GLOBAL_INSTALL_COMMAND = `npm i -g ${packageJson.name}`;
1415
const OPENSPEC_PACKAGE = '@fission-ai/openspec';
1516
const OMC_PACKAGE = 'oh-my-claude-sisyphus';
1617
const OMC_REPO_URL = 'https://github.com/Yeachan-Heo/oh-my-claudecode';
@@ -281,7 +282,7 @@ const CLI_COMMAND_DESCRIPTIONS = [
281282
['prompt', 'Print AI setup checklist (--exec, --snippet)'],
282283
['report', 'Security/safety reports (e.g. OpenSSF scorecard)'],
283284
['help', 'Show this help output'],
284-
['version', 'Print GuardeX version'],
285+
['version', 'Print GitGuardex version'],
285286
];
286287
const DEPRECATED_COMMAND_ALIASES = new Map([
287288
['init', { target: 'setup', hint: 'gx setup' }],
@@ -315,7 +316,7 @@ function defaultAgentWorktreeRelativeDir(env = process.env) {
315316

316317
const AI_SETUP_PROMPT = `GitGuardex (gx) setup checklist for Codex/Claude in this repo.
317318
318-
1) Install: npm i -g @imdeadpool/guardex && gh --version
319+
1) Install: ${GLOBAL_INSTALL_COMMAND} && gh --version
319320
2) Bootstrap: gx setup
320321
3) Repair: gx doctor
321322
4) Task loop: bash scripts/codex-agent.sh "<task>" "<agent>"
@@ -330,7 +331,7 @@ const AI_SETUP_PROMPT = `GitGuardex (gx) setup checklist for Codex/Claude in thi
330331
12) Fork sync: install https://github.com/apps/pull + cp .github/pull.yml.example .github/pull.yml
331332
`;
332333

333-
const AI_SETUP_COMMANDS = `npm i -g @imdeadpool/guardex
334+
const AI_SETUP_COMMANDS = `${GLOBAL_INSTALL_COMMAND}
334335
gh --version
335336
gx setup
336337
gx doctor
@@ -2517,7 +2518,7 @@ function runDoctorInSandbox(options, blocked) {
25172518
if (finishResult.stderr) process.stderr.write(finishResult.stderr);
25182519
} else if (finishResult.status === 'failed') {
25192520
console.log(`[${TOOL_NAME}] Auto-finish flow failed for sandbox branch '${metadata.branch}'.`);
2520-
console.log(`[guardex] Auto-finish flow failed for sandbox branch '${metadata.branch}'.`);
2521+
console.log(`[${TOOL_NAME}] Auto-finish flow failed for sandbox branch '${metadata.branch}'.`);
25212522
if (finishResult.stdout) process.stdout.write(finishResult.stdout);
25222523
if (finishResult.stderr) process.stderr.write(finishResult.stderr);
25232524
} else {

docs/branch-sync-spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GuardeX branch sync feature spec (pre-implementation)
1+
# GitGuardex branch sync feature spec (pre-implementation)
22

33
Status: draft
44
Scope: CLI UX + behavior spec + test matrix for keeping `agent/*` branches synced with `origin/dev` safely.

docs/images/guardex-service-status.svg

Lines changed: 5 additions & 5 deletions
Loading

docs/images/install-hero.svg

Lines changed: 2 additions & 2 deletions
Loading

docs/images/setup-success.svg

Lines changed: 12 additions & 12 deletions
Loading

0 commit comments

Comments
 (0)