Files
base/docs/tasks.md

4.4 KiB

task-id-prefix, projects, task-statuses, task-types
task-id-prefix projects task-statuses task-types
EX
label path value
Example Project . example-project
label value description
Planning planning Define the goals and scope.
label value description
Triage triage Decide how to approach the work.
label value description
Research research Investigate before planning or execution.
label value description
Ready ready Ready to be worked on.
label value description
In Progress in_progress Work is underway.
label value description
Testing testing Awaiting human review or verification.
label value description
Blocked blocked Waiting on a dependency or decision.
label value description
Done done Completed and verified by a human.
label value description
Cancelled cancelled No longer applicable.
value label description
task Task A project deliverable or activity.
value label description
chore Chore Routine maintenance or administrative work.
value label description
feature Feature A new capability, when relevant to the project.
value label description
bug Bug A defect to fix, when relevant to the project.

Project Task Tracker

Working with Tasks

This tracker works for any project, including writing, research, and software. testing means awaiting review or verification; it does not require automated tests. This is a sample backlog. Customize the sample task for your project.

Configuration

  • task-id-prefix controls display IDs and anchors. This example uses EX.
  • TASK_ID_PREFIX overrides frontmatter; the script default is EX.
  • Prefixes start with a letter and contain letters, digits, underscores, or hyphens. Display IDs are uppercase; anchors are lowercase.
  • Numbers are globally monotonic with at least three digits. Use a number alone with task commands to avoid dependence on the configured prefix.
  • After changing the prefix, run ./scripts/update-tasks to migrate IDs and internal links without changing task numbers.
  • projects defines labels, keys, and repository-relative paths. If renaming a project key, update corresponding task anchor data-project attributes.
  • All task commands accept -f /path/to/tasks.md; exported TASKS_FILE sets the default tracker.
  • Optional epics and subprojects can group work. Define their values and labels in frontmatter before assigning them.

Commands

The CLI tools require Python 3.9+ and Bash or Zsh. They are optional; you can also maintain this Markdown tracker with your assistant.

source ./scripts/env.sh
./scripts/get-tasks --all
./scripts/get-tasks --accept "Status:Ready"
./scripts/get-task 1 --json
./scripts/add-task "Outline the next deliverable" --project example-project --type task --status triage
./scripts/update-task 1 --status in_progress
./scripts/update-task 1 --append-description "- [ ] Additional review criterion"
./scripts/update-task 1 --status testing --check-all
./scripts/update-tasks

Task anchor attributes in Detailed Tasks are the canonical metadata. Do not manually edit generated summary or enum tables; regenerate them with update-tasks. Working agents transition completed work to testing, not done. A human confirms completion.

See the script guide and getting started guide for details.

Overall Progress

ID Title Project Status Type
EX-001 Define the project's goals Example Project Ready Task

Detailed Tasks

Define the project's goals

ID: EX-001 Project: Example Project Status: Ready Type: Task

Description: Replace this sample with the first meaningful activity for your project.

  • Describe the intended outcome and audience.
  • Identify the first deliverable.
  • Agree on how the deliverable will be reviewed or verified.

Notes

Projects (Rendered from frontmatter projects)

Task Statuses (Rendered from frontmatter task-statuses)

Task Types (Rendered from frontmatter task-types)