The board
Filters
A filter is a short query. It is used for a pane's filter, a space's scope, and on the command line.
an example
is:todo source:gitlab repo:web,api -is:draft by:alex export
Terms are separated by spaces and must all hold. key:a,b holds when any value does. A leading - negates a term. A bare word is searched in the reference, the title, the repository and the person.
Terms
| Term | Keeps |
|---|---|
is:todo, is:waiting | One side of the board. |
is:draft | Draft changes. The only way to see drafts kept apart. |
is:snoozed | What you set aside, which nothing else shows. |
source:gitlab,jira | Items from any of these sources, by the name you gave them. |
repo:web | Repositories or projects whose path contains it. |
kind:review | Tasks listed for a rule whose name contains it, looking at every reason. aki rules names the rules. |
top:draft | The same, looking only at the most pressing reason. |
role:author | author, reviewer, assignee, participant. |
by:alex | The person on the other side. |
heat:hot,warm | Tasks marked hot or warm; calm for the others. |
ticket:PROJ | Changes that name a ticket whose key contains it. ticket:any: any ticket. |
priority:high,highest | Tickets of that priority, and the changes that name one. |
agent:blocked | Tasks whose agent is working, blocked, done, idle or open. agent:any: has one. |
export | A word in the reference, title, repository or person. |
-term | Everything the term does not keep. |
Where filters are used
| Place | How |
|---|---|
| A pane | / in the board. The pane narrows as you type; Esc puts the previous filter back. |
| A space's scope | S in the board. |
| The command line | aki list --filter "repo:web kind:review" |
| The file | scope and filter in spaces.toml. |
| An assistant | The filter argument of list_tasks. |
Recipes
| To see | Filter |
|---|---|
| Reviews and re-reviews to do | is:todo kind:review |
| Everything about one repository | repo:api |
| What cannot wait | is:todo heat:hot |
| Your drafts | is:draft role:author |
| Agents that wait for you | agent:blocked |
| Work tied to high-priority tickets | priority:high,highest |
| What you wait on from one person | is:waiting by:alex |
A filter that does not parse is refused with the reason: an unknown key, or a value the key does not take.