Skip to content

Commit f41c48f

Browse files
committed
fix: correct Codex install paths and add commands reference
- Fix prompts path: ~/.codex/prompts/ (was ~/.agents/commands/) - Add Available Commands section to SKILL.md for discoverability - Document invocation patterns for Pi, Claude Code, and Codex - Bump SKILL.md version to 0.5.1 - Fix misleading file tree arrow in README
1 parent 293418a commit f41c48f

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
- Pi users now clone repo and copy skill + prompts to `~/.pi/agent/skills/` and `~/.pi/agent/prompts/`
1515
- Removed stale `pi` field from `package.json` (was pointing to non-existent root paths)
1616

17+
### OpenAI Codex Install Fix
18+
- Fixed prompts path: `~/.codex/prompts/` (was incorrectly `~/.agents/commands/`)
19+
- Prompts are optional (deprecated feature) — skill works without them via `$visual-explainer`
20+
- With prompts installed, invoke as `/prompts:diff-review`, `/prompts:plan-review`, etc.
21+
1722
### Breaking Changes
1823
- Direct Claude Code plugin install (`/plugin install https://...`) no longer works — use marketplace flow instead
1924
- `pi install https://github.com/nicobailon/visual-explainer` no longer works — use manual install

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,19 @@ rm -rf /tmp/visual-explainer
5454
**OpenAI Codex:**
5555
```bash
5656
git clone --depth 1 https://github.com/nicobailon/visual-explainer.git /tmp/visual-explainer
57+
58+
# Install skill
5759
cp -r /tmp/visual-explainer/plugins/visual-explainer ~/.agents/skills/visual-explainer
58-
mkdir -p ~/.agents/commands
59-
cp /tmp/visual-explainer/plugins/visual-explainer/commands/*.md ~/.agents/commands/
60+
61+
# Optional: Install slash commands (deprecated, but works)
62+
mkdir -p ~/.codex/prompts
63+
cp /tmp/visual-explainer/plugins/visual-explainer/commands/*.md ~/.codex/prompts/
64+
6065
rm -rf /tmp/visual-explainer
6166
```
6267

68+
Invoke with `$visual-explainer` or let Codex activate it implicitly. With prompts installed, use `/prompts:diff-review`, `/prompts:plan-review`, etc.
69+
6370
## Commands
6471

6572
| Command | What it does |
@@ -109,11 +116,11 @@ plugins/
109116
│ ├── data-table.html
110117
│ └── slide-deck.html
111118
└── scripts/
112-
└── share.sh
113-
114-
~/.agent/diagrams/filename.html → opens in browser
119+
└── share.sh ← deploy HTML to Vercel for sharing
115120
```
116121

122+
**Output:** `~/.agent/diagrams/filename.html` → opens in browser
123+
117124
The skill routes to the right approach automatically: Mermaid for flowcharts and diagrams, CSS Grid for architecture overviews, HTML tables for data, Chart.js for dashboards.
118125

119126
## Limitations

plugins/visual-explainer/SKILL.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ license: MIT
55
compatibility: Requires a browser to view generated HTML files. Optional surf-cli for AI image generation.
66
metadata:
77
author: nicobailon
8-
version: "0.5.0"
8+
version: "0.5.1"
99
---
1010

1111
# Visual Explainer
@@ -14,6 +14,21 @@ Generate self-contained HTML files for technical diagrams, visualizations, and d
1414

1515
**Proactive table rendering.** When you're about to present tabular data as an ASCII box-drawing table in the terminal (comparisons, audits, feature matrices, status reports, any structured rows/columns), generate an HTML page instead. The threshold: if the table has 4+ rows or 3+ columns, it belongs in the browser. Don't wait for the user to ask — render it as HTML automatically and tell them the file path. You can still include a brief text summary in the chat, but the table itself should be the HTML page.
1616

17+
## Available Commands
18+
19+
Detailed prompt templates in `./commands/`. In Pi, these are slash commands (`/diff-review`). In Claude Code, namespaced (`/visual-explainer:diff-review`). In Codex, use `/prompts:diff-review` (if installed to `~/.codex/prompts/`) or invoke `$visual-explainer` and describe the workflow.
20+
21+
| Command | What it does |
22+
|---------|-------------|
23+
| `generate-web-diagram` | Generate an HTML diagram for any topic |
24+
| `generate-visual-plan` | Generate a visual implementation plan for a feature |
25+
| `generate-slides` | Generate a magazine-quality slide deck |
26+
| `diff-review` | Visual diff review with architecture comparison and code review |
27+
| `plan-review` | Compare a plan against the codebase with risk assessment |
28+
| `project-recap` | Mental model snapshot for context-switching back to a project |
29+
| `fact-check` | Verify accuracy of a document against actual code |
30+
| `share` | Deploy an HTML page to Vercel and get a live URL |
31+
1732
## Workflow
1833

1934
### 1. Think (5 seconds, not 5 minutes)

0 commit comments

Comments
 (0)