Writeups
Commands: ti writeup new, ti writeup list, ti writeup show, ti writeup edit, ti writeup promote, ti writeup link, ti writeup unlink, ti writeup close
Writeups are versioned notes that live next to tickets. Use them for investigation notes, design sketches, release notes, longer implementation plans, or anything that should be preserved without becoming an actionable ticket immediately.
When to use a writeup
Use a ticket when the next action is clear and tracked through the lifecycle. Use a writeup when the work is exploratory, narrative, or expected to evolve over several edits before it becomes ticket-sized.
| Use a ticket for | Use a writeup for |
|---|---|
| Known bugs and tasks | Research notes and findings |
| Work that needs assignment or priority | Design alternatives and tradeoffs |
| Items that should move through state | Long-form implementation notes |
| Small, reviewable units of work | Drafts that may later become tickets |
Create
Create a writeup with a title and optional body. If the title or body is omitted, TicGit opens your editor.
List and read
By default, ti writeup list shows open writeups. Pass --all to include closed writeups.
Edit versions
Editing a writeup appends a new version instead of replacing the old one. That makes writeups useful for evolving notes where previous context still matters.
Link to tickets
A writeup can be linked to one or more tickets. Use this when a design note, investigation, or implementation record explains why a ticket exists or how it was handled.
Linked writeups show up in the TUI details pane and keep the long-form context close to the ticket without overloading ticket comments.
Promote into a ticket
When a writeup turns into actionable work, promote it. TicGit creates a new ticket from the writeup title and latest body.
Close or archive
Close a writeup when it is no longer active. archive is an alias for close.
Workflow
A common workflow is to start with notes, revise them as the idea becomes concrete, then either link the writeup to existing work or promote it into a ticket.