Three doc tickets in one commit, since two of them are the same check: run everything the docs claim and see what fails. 8cc254c: the add example in the kanban skill passed -t twice, once where -g for tags was meant, and gave -p three bare positional values instead of three flags. Clap rejected it with exit 2, reproduced verbatim. Rewritten, with a line saying why -t is not tags and why each step needs its own -p, since the example alone does not explain the trap. The "--due (or --due)" filler is gone; --due and --priority have no short form and now say so. a1dbd60: only title is required in the add schema now. The other six fields were unmarked, so the model had to invent a value for every field on every ticket. The other four tool schemas were checked and are already right: ls is fully optional, and the required arguments on show, mv and comment are genuinely required. Every add field was already guarded in execute, so an omitted field adds no flag. 47aa0fe: the README row it describes was already fixed in passing byddbd45e, which rewrote it for the priority work. "ls --status" appears nowhere. What was left was the second criterion, and running every example turned up a different problem: the 141 exit code documented for a truncated pipe only happens when the output exceeds the 64 KiB a pipe holds. A short listing lands in the buffer whole and reports 0. That was my own wording fromb28ddb9and it is now precise. Every example in both files was run against the built binary, with real ids substituted where they use placeholders, and the four documented exit codes were measured rather than assumed. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# Worklane
|
|
|
|
Worklane is a local Kanban flow for agentic software development.
|
|
|
|
## Commands
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `worklane init` | Creates `.worklane/` with backlog, committed, reviewing, done directories |
|
|
| `worklane add` | Creates a ticket in backlog with `--title`, `--description`, `--acceptance`, `--plan`, `--tags`, `--due`, `--owner`, `--priority` flags |
|
|
| `worklane ls [status]` | Lists tickets, sorted by priority then title. Optional positional status, and `--priority <1-5>` |
|
|
| `worklane show <id>` | Shows ticket by UUID prefix (4+ chars), title substring, or filename substring |
|
|
| `worklane mv <id> --status <target> [-f]` | Moves ticket between statuses. Default: forward only, one stage at a time. `-f` bypasses both restrictions |
|
|
| `worklane comment <ticket> <body>` | Adds a comment to a ticket by UUID or title |
|
|
|
|
## Exit codes
|
|
| Code | Meaning |
|
|
|------|---------|
|
|
| 0 | Success |
|
|
| 1 | An error, such as no matching ticket or an ambiguous search |
|
|
| 2 | A usage mistake, such as an unknown flag |
|
|
| 141 | Output was piped to a reader that stopped early, for example `worklane ls \| head -3` |
|
|
|
|
141 is 128 + 13, the shell's way of reporting death by `SIGPIPE`. Worklane restores
|
|
the default signal disposition so a truncated pipe is quiet, the way `head` and
|
|
`sort` are, rather than printing a panic. A script using `set -o pipefail` will see
|
|
141 for a case that is not a failure, so guard for it there.
|
|
|
|
Whether a truncated pipe reports 141 or 0 depends on the size of the output, not on
|
|
the command. A pipe holds 64 KiB, so a listing that fits lands in the buffer whole
|
|
and the writer never learns the reader left, giving 0. Only output past that gets far
|
|
enough to be cut off. Either way nothing is printed to stderr.
|