Skip to content

Commit 4bcaa30

Browse files
authored
docs: integrate gander-skill for AI coding agent workflow (#66)
* docs(readme): restructure for AI coding agent workflow Lead with the agentic framing ("share markdown from your agent to your browser in real time"), add a For AI coding agents section pointing at gandermd/gander-skill, and reframe the Live-reload preview + Share on gander.md sections around the agent-as-writer workflow. * docs(man): link gander-skill in SEE ALSO Add a SEE ALSO entry pointing at gandermd/gander-skill so 'man gander' surfaces the agent-skill discovery path (OpenCode, Claude Code, Codex CLI, Cursor, Grok Build, Windsurf, and any agent that loads SKILL.md files). * docs(agents): note gander-skill for agents working on gander Add a 'Using gander from an agent' addendum pointing at gandermd/gander-skill so an agent iterating on this repo can 'gander share --watch' a doc and let the human read along, or persist the agent's plan via scripts/save-plan.sh. Also expand the source-layout table to cover the share/api/signup/etc files that have accumulated since the original table was written.
1 parent ceb45d9 commit 4bcaa30

3 files changed

Lines changed: 36 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,20 @@ self-updates from GitHub Releases.
2020
| `config.go` | `~/.gander` JSON loader and defaults; honors `GANDER_CONFIG=<name>` to use `~/.gander.<name>` instead (full isolation from the prod profile, with path-traversal guard) |
2121
| `render.go` | Markdown → HTML, page builder, CSS, TOC + reload JS |
2222
| `watch.go` | HTTP server, SSE hub, fsnotify watcher, debounced reload |
23+
| `share.go` | `gander share [--watch]` upload + push-to-gandermd loop |
24+
| `api.go` | gandermd HTTP client (signup, share CRUD, manage intent) |
25+
| `signup.go`/`auth.go`/`list.go`/`remove.go`/`manage.go` | gandermd account subcommands |
2326
| `upgrade.go` | `--upgrade` self-update via GitHub Releases API |
27+
| `completion.go` | `gander completion {bash\|zsh}` |
2428
| `*_test.go` | Unit tests |
2529
| `install.sh` | Installer: downloads the latest release, source fallback |
2630
| `scripts/release.sh` | Release automation (see below) |
2731
| `.github/workflows/` | CI (currently just `release.yml`) |
2832

33+
### Using gander from an agent
34+
35+
When working on gander (or any project with a Markdown surface — design docs, plans, postmortems), install [`gandermd/gander-skill`](https://github.com/gandermd/gander-skill) so your agent can `gander share --watch` a file it's iterating on; the human opens the URL once and reads along without copy-pasting. The skill's `scripts/save-plan.sh` is also a clean way to persist this plan (and others) as markdown under `./plans/` and gander or share it before any code changes. See the `## For AI coding agents` section of `README.md` for the full pitch.
36+
2937
## Build, test, lint
3038

3139
```bash

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1-
# gander — Markdown Preview
1+
# gander — share markdown from your agent to your browser in real time
22

3-
A simple CLI tool that renders a Markdown file in your web browser on macOS and Linux.
3+
Render a Markdown file locally with `gander <file>`, or push it to a shareable URL with `gander share <file> --watch` that updates in place on every save. Built so humans and agents can read and collaborate on markdown at the same time.
4+
5+
## For AI coding agents
6+
7+
`gander` solves the problem of `cat`-ing a markdown file just to see what your agent wrote — open a browser tab once and the page updates in place on every save. Two workflows cover most of what you'll do:
8+
9+
1. **`gander share README.md --watch`** — upload to `gander.md` and get a short URL. Every save hot-swaps the rendered page in every connected viewer's browser, so you can read along while your agent iterates on a design doc without copy-pasting or refreshing.
10+
11+
2. **[`gandermd/gander-skill`](https://github.com/gandermd/gander-skill)** — a `SKILL.md` that wires all of this into your agent runner (OpenCode, Claude Code, Codex CLI, Cursor, Grok Build, Windsurf, and any other agent that loads `SKILL.md` files), plus two helper scripts:
12+
- `scripts/save-plan.sh` — pipe the agent's plan into `./plans/YYYY-MM-DD-<slug>.md`, then gander or share it.
13+
- `scripts/watch-markdown.sh` — watch a directory for new `.md` files and prompt to gander each one.
14+
15+
Install the skill with one command:
16+
17+
```bash
18+
git clone https://github.com/gandermd/gander-skill && cd gander-skill && ./install.sh
19+
```
20+
21+
That symlinks the skill into `~/.agents/skills/`, `~/.claude/skills/`, and `~/.cursor/skills/` so every supported agent picks it up automatically.
422

523
## Installation
624

@@ -122,17 +140,15 @@ gander -outfile readme.html README.md
122140
gander --watch README.md
123141
```
124142

125-
Opens the preview in your browser and watches the file for changes. Each save hot-swaps the rendered HTML in place and rebuilds the TOC scroll position is preserved. Press `Ctrl+C` to stop.
143+
Especially handy when an agent is writing the file — open the preview once and watch it grow without leaving your browser. On every save the rendered HTML hot-swaps in place and the TOC rebuilds; scroll position is preserved. Press `Ctrl+C` to stop.
126144

127145
A local HTTP server is started on a random free port (printed in the output) so the browser can receive change notifications over Server-Sent Events.
128146

129147
> `--watch` and `-outfile` cannot be combined.
130148
131149
### Share on gander.md
132150

133-
`gander.md` is the public hosting service for gander. Once you sign up,
134-
you can `share`, `list`, and `remove` markdown from your terminal — and
135-
viewers see the same live-reload preview you'd see locally.
151+
If you're running an agent that streams markdown to a file, `gander share --watch` is the shortest path from the agent's writes to your browser — open the URL once and every connected viewer sees the latest version in real time. `gander.md` is the public hosting service for gander. Once you sign up, you can `share`, `list`, and `remove` markdown from your terminal, and viewers see the same live-reload preview you'd see locally.
136152

137153
```bash
138154
gander signup --email you@example.com # opens browser form, polls for API token

man/man1/gander.1

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,12 @@ GANDER_CONFIG=dev gander signup \-\-email dev@example.com
239239
.SH "SEE ALSO"
240240
Project home page:
241241
.RI \(la https://github.com/gandermd/gander-cli \(ra.
242+
.IP
243+
The gander agent skill (\(lqgander-skill\(rq) for OpenCode, Claude Code,
244+
Codex CLI, Cursor, Grok Build, Windsurf, and any agent that loads
245+
.SB SKILL.md
246+
files:
247+
.RI \(la https://github.com/gandermd/gander-skill \(ra.
242248
.SH AUTHORS
243249
.B gander
244250
is developed at

0 commit comments

Comments
 (0)