Skip to content

Commit 0752a7e

Browse files
NagyViktNagyViktclaude
authored
README: add back hero/problem/workflow images + companion tools table (#413)
Brings back three images that shipped in the previous README and a companion-tools section with star badges for every helper `gx status` auto-detects: - `docs/images/install-hero.svg` in section 01 (Install) - `docs/images/problem-agent-collision.svg` in section 02 (The problem) - `docs/images/workflow-source-control-grouped.png` after section 04 tip - new section `10 Companion tools` with 8 rows: oh-my-codex, oh-my-claudecode, OpenSpec, cavemem, cavekit, caveman, codex-account-switcher, GitHub CLI (`gh`) — each linked with an install snippet and a `?style=social` star badge to the upstream repo. Also threads `Companions` into the top nav strip so the section is discoverable without scrolling through the help tree. All three image paths use the raw.githubusercontent.com URL pattern so the images render on both github.com and npmjs.com (relative paths often break on npm's README panel). Bumps `@imdeadpool/guardex` 7.0.32 -> 7.0.33 so the next `npm publish` ships the updated README. Co-authored-by: NagyVikt <nagy.viktordp@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f0ef368 commit 0752a7e

2 files changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,18 @@
2525
<a href="#04--daily-workflow">Workflow</a> ·
2626
<a href="#05--what-gx-shows-first">gx status</a> ·
2727
<a href="#07--commands">Commands</a> ·
28-
<a href="#08--v6--v7-migration">Migration</a>
28+
<a href="#08--v6--v7-migration">Migration</a> ·
29+
<a href="#10--companion-tools">Companions</a>
2930
</p>
3031

3132
---
3233

3334
## `01` &nbsp;Install in one line
3435

36+
<p align="center">
37+
<img alt="Install GitGuardex" src="https://raw.githubusercontent.com/recodeee/gitguardex/main/docs/images/install-hero.svg" width="680">
38+
</p>
39+
3540
```bash
3641
npm i -g @imdeadpool/guardex
3742
cd /path/to/your-repo
@@ -54,6 +59,8 @@ gx setup # hooks, state, OMX / OpenSpec / caveman wiring — one shot
5459

5560
## `02` &nbsp;The problem
5661

62+
![Parallel agents colliding in the same files](https://raw.githubusercontent.com/recodeee/gitguardex/main/docs/images/problem-agent-collision.svg)
63+
5764
I was running ~30 Codex agents in parallel and hit a wall: they kept
5865
working on the same files at the same time — especially tests — and
5966
started overwriting or deleting each other's changes. More agents meant
@@ -119,6 +126,8 @@ gx branch finish --branch "$(git rev-parse --abbrev-ref HEAD)" \
119126
> session exits — auto-commits, retries once if the base moved mid-run,
120127
> then pushes and opens the PR.
121128
129+
![Guarded VS Code Source Control example](https://raw.githubusercontent.com/recodeee/gitguardex/main/docs/images/workflow-source-control-grouped.png)
130+
122131
---
123132

124133
## `05` &nbsp;What `gx` shows first
@@ -240,6 +249,25 @@ Being honest about where this still has issues:
240249

241250
---
242251

252+
## `10` &nbsp;Companion tools
253+
254+
All optional — but if you're running many agents, you probably want them.
255+
`gx status` auto-detects each one and reports it in the `Global services`
256+
block.
257+
258+
| Tool | What it does | Stars |
259+
| --- | --- | --- |
260+
| [**oh-my-codex**](https://github.com/Yeachan-Heo/oh-my-codex)`npm i -g oh-my-codex` | Codex config + skills framework. Merged into every agent worktree so each spawned Codex starts with the same tuned config. | [![stars](https://img.shields.io/github/stars/Yeachan-Heo/oh-my-codex?style=social)](https://github.com/Yeachan-Heo/oh-my-codex) |
261+
| [**oh-my-claudecode**](https://github.com/Yeachan-Heo/oh-my-claudecode)`npm i -g oh-my-claude-sisyphus@latest` | Claude-side mirror of oh-my-codex. Skills, commands, and defaults for every Claude Code session. | [![stars](https://img.shields.io/github/stars/Yeachan-Heo/oh-my-claudecode?style=social)](https://github.com/Yeachan-Heo/oh-my-claudecode) |
262+
| [**OpenSpec**](https://github.com/Fission-AI/OpenSpec)`npm i -g @fission-ai/openspec` | Structured plan / change / apply / archive flow so long agent runs don't drift off-task. | [![stars](https://img.shields.io/github/stars/Fission-AI/OpenSpec?style=social)](https://github.com/Fission-AI/OpenSpec) |
263+
| [**cavemem**](https://github.com/JuliusBrussee/cavemem)`npm i -g cavemem` | Local persistent memory for agents via SQLite + MCP. Retains compressed history across runs. | [![stars](https://img.shields.io/github/stars/JuliusBrussee/cavemem?style=social)](https://github.com/JuliusBrussee/cavemem) |
264+
| [**cavekit**](https://github.com/JuliusBrussee/cavekit)`npx skills add JuliusBrussee/cavekit` | Spec-driven build loop with `spec`, `build`, `check`, `caveman`, `backprop` skills bundled in. | [![stars](https://img.shields.io/github/stars/JuliusBrussee/cavekit?style=social)](https://github.com/JuliusBrussee/cavekit) |
265+
| [**caveman**](https://github.com/JuliusBrussee/caveman)`npx skills add JuliusBrussee/caveman` | Ultra-compressed response mode for Claude / Codex. Less output-token churn on long reviews and debug loops. | [![stars](https://img.shields.io/github/stars/JuliusBrussee/caveman?style=social)](https://github.com/JuliusBrussee/caveman) |
266+
| [**codex-account-switcher**](https://github.com/recodeecom/codex-account-switcher-cli)`npm i -g @imdeadpool/codex-account-switcher` | Multi-identity Codex account switcher. Auto-registers accounts on `codex login`; switch with one command. | [![stars](https://img.shields.io/github/stars/recodeecom/codex-account-switcher-cli?style=social)](https://github.com/recodeecom/codex-account-switcher-cli) |
267+
| [**GitHub CLI (`gh`)**](https://github.com/cli/cli) — see [cli.github.com](https://cli.github.com/) | Required for PR / merge automation. `gx branch finish --via-pr --wait-for-merge` depends on it. | [![stars](https://img.shields.io/github/stars/cli/cli?style=social)](https://github.com/cli/cli) |
268+
269+
---
270+
243271
<p align="center">
244272
<sub>
245273
— PRs and issues welcome ·

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@imdeadpool/guardex",
3-
"version": "7.0.32",
3+
"version": "7.0.33",
44
"description": "Guardian T-Rex for your multi-agent repo. Isolated worktrees, file locks, and PR-only merges stop parallel Codex & Claude agents from overwriting each other's work. Auto-wires Oh My Codex, Oh My Claude, OpenSpec, and Caveman.",
55
"license": "MIT",
66
"preferGlobal": true,

0 commit comments

Comments
 (0)