Tsk CLI

tsk: the user's task board

tsk is the user's task board. Tasks have a human status (open · ready · started · blocked · review · done), live on the desk (no project) or in a project (a Git repo root, named by its basename), and may carry a thread label. The user sees the board in a TUI; you never open it. Every read and write goes through the CLI, and the user's board updates live.

tsk --help is the syntax reference: commands, statuses, and every flag. Run tsk help <command> before the first use of a command in a session; this file only holds what --help cannot tell you: how to behave on someone else's board.

If tsk is not installed

Run command -v tsk. If it is missing, give the user https://gettsk.sh/docs/install.md and stop. Never run install.sh, brew, or cargo build unless they asked.

Board language

T12, t12, 12, and the UUID all address the same task. Prefer T12, it is what the user sees. New tasks start open in the inbox; ready means the user picked it.

Rules

1. Human status is the user's. When your work on a task is finished, set review. Set done only when the user says the task is done or told you to close it. Never mark tasks done from your own progress.
2. Check the scope before -p name. A typo silently files the task under a new project. Confirm with tsk list --all --json (the project field) when unsure. tsk edit cannot move a task: re-add in the right scope and archive the stray.
3. Read JSON, not presentation. Always add --json to tsk list. Human output is for showing the user or troubleshooting interactively. Mutation acknowledgements may be human-only: trust the exit and refusal codes, then verify state with tsk list … --json.
4. Never blind-retry. Read the exit code, then act (table below). add, status, edit, archive are idempotent; steps toggle and steps remove are not, so run tsk list T12 --json before retrying any steps command.
5. Never pass --state-dir unless the user asked. It points at a different board.
6. Ignore notice rows. Rows the board paints as N1… are human-only (starter tasks and release notes). tsk list --json never shows them and no command addresses them.
7. Values that begin with - need the = form: --title="-fix parser", --notes="-5 degrees".
8. Thread names start with a letter or digit, then lowercase letters, digits, - and ., up to 32 characters. --thread lowercases the value; anything else is a usage error (exit 2). In a JSON plan a bad thread is an item refusal (invalid-thread).

Exit contract (all commands)

add, status, edit, steps, archive and unarchive print a stable refusal code first (tsk status: unknown-task: T12 is not on the board), listed per command under tsk help <command>. Branch on the code; the message is not a contract. trash restore and project refuse with a message only.

Workflows

What's on the board. tsk list --json (this repo's project, or the desk outside Git). Group by status in board language, lead with what needs the user, then in motion, then on deck.

Start work on a task. tsk list T12 --json for notes and steps. tsk status T12 start. Tick steps as you go: tsk steps T12 toggle <short_id>.

Hand back. tsk status T12 review, and say in one line what you did and what to look at. Blocked on the user: tsk status T12 blocked and ask the question.

Plan as steps. When the user wants order of work tracked on the task: tsk steps T12 add "…" per step, in order. Do not add steps for your own bookkeeping.

Capture many. cat plan.json | tsk add with [{"title": "…", "notes": "…", "project": "…", "thread": "…"}]; only title is required, an omitted project takes the default scope. The result lists created, existing and failed items; on exit 1 retry only the failed items, never the whole plan. Full shape: https://gettsk.sh/docs/cli.md#json-plans.

Refine a task

Use when the user asks to refine, discuss, improve, rewrite, or find what's missing from a task, or brings a rough idea that should become one. This is a shaping pass, not a build: no acceptance criteria, no design document, no code. It ends with a better task on the board.

Hard gate: propose, then write. Show the full rewrite (title and notes) and get a yes before any tsk edit or tsk add. edit --notes replaces the whole body; a silent write loses the user's own words.

1. Read. tsk list T12 --json for the task as written. Then tsk list --json (and --all --json when the task may belong elsewhere) for neighbours in the same project or thread: duplicates, a task this depends on or unblocks, a thread it should join.
2. Ground in code. Before saying anything, open the files, docs, and tests the task touches. Check the user's claims against what exists; when the code answers a question, do not ask it.
3. Diverge briefly. Two or three approaches with tradeoffs, recommendation first and why. Scale to the task: a bug fix gets two lines, a feature gets a short list. Draw a mock in a code block when the shape lands better than prose (a screen, a table, a CLI transcript).
4. Grill, one question at a time. Multiple-choice with a recommended answer. Prefer reading code over asking. Sharpen fuzzy or overloaded words into one canonical term and use only that term afterwards. When an answer exposes that the framing was wrong, go back to step 3 for that part instead of building on it.
5. Settle and propose. Present the rewrite in the notes shape below, then the exact commands you will run. Stop and wait.
6. Write back on a yes.
   • Exists: tsk edit T12 --title "…" --notes "…".
   • Does not exist yet: tsk add -t "…" -n "…" in the agreed scope (--desk, -p), with --thread if agreed.
   • Steps only when the user wants order of work tracked: tsk steps T12 add "…" per step.
   • Never change status. edit cannot change scope or thread: for a scope change re-add in the right scope and archive the stray; say so before doing it.
7. Stop. The hand-off is the updated or created task. Report its number and title in one line. Do not offer builders, worktrees, or plans, and do not start building unless asked.

Title: the outcome, verb-first, under about 60 characters (Make tsk --help the CLI reference, not help improvements).

Notes shape (the board renders **bold**, *em*, `code`, # headings, - lists, fenced code):

Ask: <the user's words, verbatim, one or two lines>

Settled
- <one actionable sentence per decision>

Rules / edge cases
- <behaviour at the boundaries, refusals, what must not change>

Shape
- <files, modules, surfaces to touch; what not to touch>

Open
- <deferred question, and why it can wait>

Omit a heading that would be empty. Keep the user's terms once sharpened; the notes are the brief a future agent (or the user) builds from without this conversation.