Skip to content

Commit 40bb1e7

Browse files
docs(readme): document terminal file attachments (drag, Ctrl+V, @path, /paste)
1 parent 9682335 commit 40bb1e7

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,27 @@ merge / split / stamp / watermark PDFs — all with pure-JS libraries, no sandbo
300300
Drop a document into a channel and Brigade sees it; ask for a report and it hands
301301
one back with `send_media`.
302302

303+
### 📎 Attach files in the terminal
304+
Send your crew an image, a PDF, a screenshot, a video — from the chat TUI, with
305+
no ceremony. Four ways in, and they all land as a real attachment:
306+
307+
- **Drag a file onto the window** — the path turns into a `[filename]` chip the
308+
instant it lands, before you press anything.
309+
- **`Ctrl+V`** — paste an image and it attaches; paste text and it types, exactly
310+
as before. Brigade reads the clipboard on the paste event your terminal sends,
311+
so a copied screenshot just works.
312+
- **`@path`** — an autocompleting file picker; type `@` and fuzzy-find.
313+
- **`/attach <path>`**, **`/paste`**, **`/detach`** — the explicit backbone, plus
314+
`/clipboard` to see what's on your clipboard and which build is running.
315+
316+
An **image** on a vision-capable model rides the turn inline — the model actually
317+
*sees* it. A **text or source file** is read and its contents are inlined
318+
directly. **PDFs, Office docs, video and audio** go through `analyze_media` (see
319+
above). A persistent clipboard worker keeps a paste to a few milliseconds on every
320+
platform, and a `📎 attached` bar shows what will ride your next message. Works
321+
against a local gateway (files travel as paths, so a 400 MB video costs nothing on
322+
the wire).
323+
303324
### 🎬 Motion-graphics video (HyperFrames)
304325
`render_video` turns an HTML composition into a **deterministic MP4** — animated
305326
charts and dashboards, data explainers, quote/announcement cards, kinetic
@@ -681,11 +702,14 @@ When you're in the chat TUI (`brigade` or `brigade connect`):
681702
| `/reasoning [on\|off]` | Toggle whether thinking blocks render |
682703
| `/compact` | Force a context compaction now |
683704
| `/abort`, `/steer "<text>"` | Stop the current turn, or inject mid-turn guidance |
705+
| `/attach <path>`, `/paste`, `/detach [<n>\|all]` | Stage a file, pull from the clipboard, or unstage |
706+
| `/clipboard` | What's on your clipboard, plus the running build + worker health |
684707
| `/usage` | Token + cost usage for this session |
685708
| `/help`, `/exit` | Show all commands / quit |
686709

687710
Keyboard: **Enter** sends · **Ctrl+C** stops the current response · **Ctrl+D**
688-
quits · **↑/↓** history.
711+
quits · **↑/↓** history · **Ctrl+V** pastes an image as an attachment · drag a
712+
file onto the window to attach it.
689713

690714
---
691715

0 commit comments

Comments
 (0)