From 49d5bbc62cbd8b8057c049e1ebdb880570770b99 Mon Sep 17 00:00:00 2001 From: Ayo Date: Sat, 11 Jul 2026 11:51:09 +0200 Subject: [PATCH] chore(tasks): add instructions to use tasks app --- README.md | 8 ++++++++ TASK_TEMPLATE.md | 26 ++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 TASK_TEMPLATE.md diff --git a/README.md b/README.md index 68ec726..ea30208 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,14 @@ $ cp example.conf ~/ayo.conf 4\. update your .bashrc to add an alias for the parent command `scripts/ayo.sh` +## Tasks + +The `task-tui` uses a `TASKS_HOME` variable in the configuration file. It looks for plain text files that follows the [template](./TASK_TEMPLATE.md). + +The tasks text files need to be in one of the status directories: `backlog`, `next`, `in-progress`, or `done`. + +After setting the `TASKS_HOME` variable in the configuration file `ayo.conf` and an alias to `ayo.sh` with `yo` in your `.bashrc` file, you can run the app with `yo tasks`. + ## Examples To ask the AI a question diff --git a/TASK_TEMPLATE.md b/TASK_TEMPLATE.md new file mode 100644 index 0000000..f77fb91 --- /dev/null +++ b/TASK_TEMPLATE.md @@ -0,0 +1,26 @@ +--- +id: YYYY-MM-DD-short-slug # stable handle (creation-stamped); unchanged by later renames +title: One-line task title +priority: P2 # P0 urgent · P1 high · P2 normal · P3 someday +owner: Hermes # Hermes | Claude | Ayo +sanitized-by: # set to "Hermes" ONLY after redaction — REQUIRED before owner: Claude (redaction gate, operations/README.md) +sanitized-on: # YYYY-MM-DD Hermes redacted; pairs with sanitized-by +context: @admin # @code | @calls | @errand | @home | @admin | @waiting +project: # optional — ID(s) of related project(s), e.g. garden-planner or [a, b] +created: YYYY-MM-DD +links: [] # related tasks, policy docs, or output files +--- + + +## Goal +What done looks like, in one or two sentences. + +## Notes +Context, sub-steps, blockers. + +## Log +- YYYY-MM-DD — created.