chore(tasks): add instructions to use tasks app

This commit is contained in:
ayo 2026-07-11 11:51:09 +02:00
parent fabaf8aa9f
commit 49d5bbc62c
2 changed files with 34 additions and 0 deletions

View file

@ -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

26
TASK_TEMPLATE.md Normal file
View file

@ -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
---
<!-- Status = which folder this file is in (backlog/next/in-progress/done); there is no
status field. The FILENAME's date is the last-updated date — rename it (YYYY-MM-DD-slug)
whenever the task changes, e.g. to the completion date when it moves to done/. "Waiting"
is a context (context: @waiting), not a folder. Projects are separate flat documents in
operations/projects/; link a task to one via the `project:` field above. -->
## Goal
What done looks like, in one or two sentences.
## Notes
Context, sub-steps, blockers.
## Log
- YYYY-MM-DD — created.