diff --git a/docs/redditpost.md b/docs/redditpost.md index e7cdeb2..8fc386b 100644 --- a/docs/redditpost.md +++ b/docs/redditpost.md @@ -1,61 +1,88 @@ -# Reddit post drafts for GuardeX +# Reddit Post Kit for GuardeX -GitHub: https://github.com/recodeecom/multiagent-safety +Source baseline: [`README.md`](../README.md) -## Draft 1 (general) +Project links: +- GitHub: https://github.com/recodeecom/multiagent-safety +- npm: https://www.npmjs.com/package/@imdeadpool/guardex + +## Recommended Title Options -**Title:** -I made an npm tool to keep multi-agent coding safe in Git repos (GuardeX) +1. `I open-sourced GuardeX: Git guardrails for multi-agent coding workflows` +2. `GuardeX (npm): safer branch + file-ownership workflow for parallel coding agents` +3. `Built an OSS CLI to stop multi-agent Git collisions (GuardeX)` -**Body:** -Hey everyone šŸ‘‹ +## Copy-Ready Reddit Post (long) -I built **GuardeX**, a small npm CLI to make multi-agent coding workflows safer and less chaotic in any Git repo. +I open-sourced **GuardeX**, a CLI that adds guardrails for multi-agent coding in Git repos. -If you run multiple agents (or teammates) in parallel, this helps prevent: +The goal is simple: if several agents (or teammates) work in parallel, prevent the common failure modes before they land in `main`. -- direct commits to protected branches (`dev`/`main`/`master` and configurable extras) -- file ownership collisions between agents -- unsafe deletes of claimed files -- stale lock/worktree mess +What it does: + +- enforces isolated agent branches/worktrees +- protects base branches (`main`, `master`, `dev`, plus configurable extras) +- supports file ownership locks to reduce agent collisions +- blocks risky deletion flows for claimed files +- includes setup/doctor scripts to bootstrap and repair workflow safety Quick start: ```bash -npm i -g gx +npm i -g @imdeadpool/guardex gx setup ``` -Useful commands: +Useful follow-up commands: ```bash -gx protect list -gx protect add release staging +gx doctor +bash scripts/agent-branch-start.sh "task" "agent-name" +python3 scripts/agent-file-locks.py claim --branch "$(git rev-parse --abbrev-ref HEAD)" +bash scripts/agent-branch-finish.sh --branch "$(git rev-parse --abbrev-ref HEAD)" ``` -Links: - -- GitHub: https://github.com/recodeecom/multiagent-safety -- npm: https://www.npmjs.com/package/@imdeadpool/guardex - -If you try it, I’d love feedback on team workflows and edge cases. - -## Draft 2 (short) +If you run Codex/Claude-style parallel workflows, I would value feedback on edge cases your team hits in production. -**Title:** -GuardeX: open-source npm CLI for safer multi-agent Git workflows +GitHub: https://github.com/recodeecom/multiagent-safety +npm: https://www.npmjs.com/package/@imdeadpool/guardex -**Body:** -I open-sourced **GuardeX** to add guardrails for parallel coding agents in Git repos. +## Copy-Ready Reddit Post (short) -It blocks risky protected-branch commits, enforces per-file ownership locks for agent branches, and includes workflow scripts for branch start/finish. +I open-sourced **GuardeX** for safer multi-agent Git workflows. -Install: +It adds branch/worktree guardrails, protected-branch enforcement, file-lock ownership, and repair scripts (`gx setup` / `gx doctor`) so parallel agent execution is safer by default. ```bash -npm i -g gx +npm i -g @imdeadpool/guardex gx setup ``` GitHub: https://github.com/recodeecom/multiagent-safety npm: https://www.npmjs.com/package/@imdeadpool/guardex + +## Images to include in the Reddit post + +Use these in a gallery post or as follow-up images in comments: + +1. Multi-agent dashboard overview + `https://raw.githubusercontent.com/recodeecom/multiagent-safety/main/docs/images/dashboard-multi-agent.png` +2. Agent branch/worktree start protocol + `https://raw.githubusercontent.com/recodeecom/multiagent-safety/main/docs/images/workflow-branch-start.svg` +3. Lock + deletion guard protocol + `https://raw.githubusercontent.com/recodeecom/multiagent-safety/main/docs/images/workflow-lock-guard.svg` +4. Source-control multi-branch visibility + `https://raw.githubusercontent.com/recodeecom/multiagent-safety/main/docs/images/workflow-source-control.svg` +5. Real VS Code Source Control layout + `https://raw.githubusercontent.com/recodeecom/multiagent-safety/main/docs/images/workflow-vscode-guardex-real.png` +6. Setup/status screenshot + `https://raw.githubusercontent.com/recodeecom/multiagent-safety/main/docs/images/setup-success.svg` + +## Embedded image previews (for docs) + +![Multi-agent dashboard overview](./images/dashboard-multi-agent.png) +![Agent branch/worktree start protocol](./images/workflow-branch-start.svg) +![Lock + deletion guard protocol](./images/workflow-lock-guard.svg) +![Source-control multi-branch visibility](./images/workflow-source-control.svg) +![Real VS Code Source Control layout](./images/workflow-vscode-guardex-real.png) +![Setup/status screenshot](./images/setup-success.svg)