Files
worklane/assets/SKILL.md
T
Ansho ReiandClaude Opus 5 3085b0226f (4179958) Add a Relations section for blocked by, regression of and relates to, and bump to 0.11.0
`relate` is the only writer of the section, the way `chown` is the only writer of
Owner: a relation names a target that has to be resolved to a uuid first, so `set`
and `append` are deliberately kept out of it. One flag per kind, so an unknown kind
is a usage error rather than a line refused on the way back out.

One direction is stored and the inverse is derived by a scan. `blocked by` goes on
the gated ticket, whose move `mv` now refuses while the target is not done, naming
every open blocker; `-f` bypasses it beside the backward and skipping moves. A
target that is not on the board warns and allows the move.

The rendered block is built outside `content_trim` and passed in, since half of it
comes from other tickets. The section is created on demand rather than by `add`, so
a ticket written before it existed gains it without being regenerated.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-21 22:33:12 +02:00

8.4 KiB

name, description
name description
worklane Manage tickets on a local worklane kanban board with the `worklane` CLI, backed by markdown files in a `.worklane/` directory. Use whenever you need to file, find, read, update, comment on or move a ticket, when asked what is on the board or what to pick up next, and when reporting work you are not going to do in the change at hand. Covers the four statuses, how a ticket is addressed, what belongs in each section, and the argument traps that silently swallow a flag.

worklane

A kanban board as files. Every ticket is one markdown file in .worklane/<status>/, named <uuid>_<slug>.md, and comments live in .worklane/comments/<uuid>/. The CLI is the only thing that writes there: do not hand-edit or hand-place a file, because the filename, the Status field and the directory have to agree and the commands are what keep them agreeing.

Commands walk up from the working directory to find the nearest .worklane, so run worklane inside the repo the ticket belongs to. Which directory you run it in is what decides which board the ticket lands on.

worklane with no subcommand opens an interactive board and needs a terminal. It is for a person, not for you: it takes over the screen and does not return until quit.

The flow

backlog → committed → reviewing → done

Move the ticket as you work it, not afterwards. worklane mv <id> --status committed before writing any code, and --status reviewing once it is done and the tests pass. The board is then true while the work is in progress, not only after it lands, which is the whole point of having a committed column.

Only one stage at a time is allowed, so a ticket left in backlog until the end cannot go straight to reviewing and has to be walked through committed anyway. Doing it up front is the same two commands in a more useful order. -f allows a backward or skipping move, for correcting a mistake.

A move is also refused while the ticket is blocked by one that is not done yet, see Relating tickets.

Reading the board

worklane ls                      # every status, counts then tickets
worklane ls backlog              # one status
worklane ls --priority 1         # only the most urgent
worklane show 1b78a24            # one ticket, body and comments

ls prints a seven-character id per ticket. That is what you address it by.

Working a ticket

worklane mv 1b78a24 --status committed
worklane check 1b78a24 3                      # tick acceptance criterion 3
worklane check 1b78a24 "the footer describes"  # or a substring of it
worklane uncheck 1b78a24 3
worklane comment 1b78a24 "Found the cause: the offset was never passed to the widget."
worklane mv 1b78a24 --status reviewing

Criteria are numbered by show. With the criterion omitted, check prompts when there is a terminal and otherwise fails with the numbered list, so always pass the criterion when you are not sitting at a prompt.

Filing a ticket

worklane add \
  --title "The tui detail view cannot scroll" \
  --description "Opening a ticket and pressing down moves to the next one instead." \
  --description "" \
  --description "Up and down are bound to select_card unconditionally, src/main.rs." \
  --acceptance "PageUp and PageDown scroll the detail view" \
  --acceptance "The footer describes the keys that exist" \
  --plan "Add a scroll offset to Board and pass it to Paragraph::scroll" \
  --plan "Clamp against the wrapped line count, not the raw line count" \
  --priority 2 --tags bug,tui

add always lands in backlog. Nothing is created without --title.

  • --description is the case for the ticket: the symptom, then what is actually wrong, naming the files, functions and settings involved. Repeat the flag for more lines; an empty --description "" between two values is a paragraph break.
  • --acceptance takes one criterion per flag, each a statement that can be checked off as true or false.
  • --plan takes one step per flag, numbered for you.
  • --priority runs 1 (most urgent) to 5 (least), and is left unset if omitted.

Editing afterwards, on a ticket in any status:

worklane set 1b78a24 --priority 1              # replace a field
worklane set 1b78a24 --title "A better title"   # renames the file, keeps the uuid
worklane append 1b78a24 --acceptance "One more criterion"
worklane append 1b78a24 --description "What was learned since."
worklane chown alice 1b78a24                    # hand the ticket to someone

set replaces, append adds. Neither has --owner or --status: owner is chown's and status is mv's, so each field has exactly one writer. A field set to the value it already holds is reported unchanged and nothing is written.

chown takes the user first and the ticket second, after Unix chown, which is the one command here that does not start with the ticket. The user is free text and is checked against nothing. Swap the two and the call fails, because the username has to resolve as a ticket.

worklane init creates .worklane/ with the four status directories, for a repo that has no board yet.

Relating tickets

worklane relate 1b78a24 --blocked-by 4179958     # this one waits on that one
worklane relate 1b78a24 --regression-of 6d327df  # this one broke that one's fix
worklane relate 1b78a24 --relates-to 7bfb9fc     # neighbours, no dependency

One flag per kind, and each repeats. The ticket comes first and the flag says what it is to the target, so read the call as a sentence: relate A --blocked-by B means A waits on B. Only one side is stored, on the ticket you name, and show derives the other end for the ticket at the far side, so never record both directions.

--blocked-by is enforced: mv refuses to move a ticket while a ticket it is blocked by is not in done, whichever move it is, and names every open blocker. -f moves it anyway, beside the backward and skipping moves it already allows. The other two kinds are reference data and never refuse anything.

Recording a relation the ticket already holds reports no change. A ticket cannot relate to itself, and a target that later disappears shows as _missing_ rather than silently going away.

Search the backlog before filing

Run worklane ls in the directory the ticket would land in and look for the same issue, including tickets already committed, in review or done. Search by the symptom and by the name of the function or setting involved, not only by your own phrasing of the title: an existing ticket will have been written from a different angle.

  • Already there and still open: add what you learned as a comment, not a second ticket.
  • Already there and closed, but the issue is back: file a new ticket naming the old id, and record it with relate <new> --regression-of <old>. There is no way to reopen one, and moving a done ticket back would destroy the record of the original fix.
  • Related but not the same: file it, and record it with relate <new> --relates-to <old> rather than only mentioning the id in prose.

Addressing a ticket

Every command that takes a ticket accepts, in this order of precedence:

  1. a UUID prefix, from four characters up
  2. a substring of the title
  3. a substring of the filename

The first tier that matches anything wins outright; the later tiers are not consulted. This matters because ticket titles quote other tickets' ids, and a flat search reported an exact id as ambiguous against whichever title mentioned it. An ambiguous match prints the candidates and exits 1 rather than guessing.

Traps

  • Prose arguments accept a leading hyphen: --title, --description, --acceptance, --plan and the comment body. A criterion reading --print is supported is stored, not parsed as a flag. The cost is that a genuinely mistyped flag there lands as content instead of failing, so read back what you wrote with worklane show.
  • --due, --priority, --tags, --owner and --status do not accept one, so a mistyped flag on those is a usage error and nothing is written.
  • A ticket argument that starts with a hyphen needs the flags first and a separator: worklane mv --status committed -- -leading-title.
  • A comment body of exactly -- needs its own separator: worklane comment 1b78a24 -- --.
  • An empty value for a scalar is a usage error. Clearing a field back to unset is not supported yet.
  • Piping is safe: worklane ls | head -3 exits on the closed pipe instead of panicking.