~kris/hacks

stask

ref: 648b969d4f84d91082a49337fb0695c824a6ea91 stask/stask.1 -rw-r--r-- 4.5 KiB
648b969d — Kris Yotam convert README.md to README.txt 4 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
.TH STASK 1 "2026-03-21" "stask 0.2" "Simple Task Manager"
.SH NAME
stask \- simple task manager with markdown documents
.SH SYNOPSIS
.B stask
.RB [ \-ghv ]
.br
.B stask
.RB [ ls ]
.br
.B stask
.B new
.I list
.br
.B stask
.B rm
.I list
.br
.B stask
.I list
.br
.B stask
.I list
.B add
.I \(dqtext\(dq
.br
.B stask
.I list
.B done
.I id
.br
.B stask
.I list
.B undo
.I id
.br
.B stask
.I list
.B del
.I id
.br
.B stask
.I list
.B edit
.I id
.br
.B stask
.I list
.B show
.I id
.SH DESCRIPTION
.B stask
is a suckless\-style task manager written in C. Tasks are organized into
named lists and stored in a SQLite database. Each task has an associated
markdown document with YAML frontmatter, allowing rich notes and planning
alongside simple checklist tracking.
.PP
When a task is created, a markdown file is generated at
.IR ~/.local/share/stask/docs/<list>/<id>.md .
The frontmatter contains the task title, date, and done status.
Editing the title in the frontmatter and saving will sync it back to the
database.
.SH OPTIONS
.TP
.B \-g
Launch the GTK4 graphical interface. Features a list sidebar, task panel
with checkboxes, and a light/dark theme toggle.
.TP
.B \-h, \-\-help
Print usage information and exit.
.TP
.B \-v, \-\-version
Print version and exit.
.SH COMMANDS
.SS List Management
.TP
.B ls
List all task lists with task counts and creation dates. This is the
default when no arguments are given.
.TP
.BI ls " list"
Show all tasks in
.IR list .
Equivalent to
.BI stask " list" .
.TP
.BI new " list"
Create a new task list named
.IR list .
Names must be unique.
.TP
.BI rm " list"
Remove a task list and all its tasks. Also deletes all associated
markdown documents.
.TP
.I list
Show all tasks in
.IR list ,
displaying their done status, ID, title, and date.
.SS Task Operations
.TP
.IB list " add " \(dqtext\(dq
Add a new task to
.I list
with the given
.IR text .
The text must be quoted if it contains spaces (e.g.,
.BR """On the Modern Professor""" ).
Creates a markdown document with YAML frontmatter at
.IR ~/.local/share/stask/docs/<list>/<id>.md .
Prints the assigned task ID.
.TP
.IB list " done " id
Mark task
.I id
as completed. Updates the
.B done
field in the markdown frontmatter to
.BR true .
.TP
.IB list " undo " id
Mark task
.I id
as not completed. Updates the
.B done
field in the markdown frontmatter to
.BR false .
.TP
.IB list " del " id
Permanently delete task
.I id
from the database and remove its markdown document.
.TP
.IB list " edit " id
Open the markdown document for task
.I id
in an editor. Uses
.B $EDITOR
if set, otherwise falls back to
.BR nvim (1),
.BR vim (1),
or
.BR vi (1)
in that order. When the editor exits, the title is synced from the
frontmatter back to the database.
.TP
.IB list " show " id
Print the markdown document for task
.I id
to standard output.
.SH DOCUMENT FORMAT
Each task document uses YAML frontmatter:
.PP
.RS
.nf
---
title: "Read Gwern's selection effects piece"
date: 2026-03-21
done: false
---

Notes, links, and planning go here.
.fi
.RE
.PP
The
.B title
field is what appears in task listings. Edit it in the frontmatter and
it will sync back to the database on
.BR edit .
The
.B done
field is kept in sync automatically by the
.B done
and
.B undo
commands.
.SH FILES
.TP
.I ~/.local/share/stask/stask.db
SQLite database containing all lists and tasks.
.TP
.I ~/.local/share/stask/docs/<list>/<id>.md
Markdown documents for individual tasks, organized by list name.
.SH ENVIRONMENT
.TP
.B EDITOR
Preferred text editor for the
.B edit
command. If unset, stask tries nvim, vim, then vi.
.SH EXAMPLES
Create a list and add tasks:
.PP
.RS
.nf
$ stask new essays
Created list 'essays'

$ stask essays add "On the Modern Professor"
Added to 'essays' (id: 1)

$ stask essays add "Formal Verification in Practice"
Added to 'essays' (id: 2)
.fi
.RE
.PP
View tasks in a list:
.PP
.RS
.nf
$ stask essays
essays:
  [ ] 1    On the Modern Professor                  2026-03-21
  [ ] 2    Formal Verification in Practice           2026-03-21
.fi
.RE
.PP
Edit a task document (opens nvim/vim):
.PP
.RS
.nf
$ stask essays edit 1
.fi
.RE
.PP
Mark a task done:
.PP
.RS
.nf
$ stask essays done 1
.fi
.RE
.PP
View all lists:
.PP
.RS
.nf
$ stask ls
LIST                      TASKS       DONE  CREATED
essays                        2          1  2026-03-21
.fi
.RE
.PP
Launch GUI:
.PP
.RS
.nf
$ stask -g
.fi
.RE
.SH BUGS
Report bugs at https://github.com/krisyotam/stask/issues
.SH AUTHOR
Kris Yotam <krisyotam@protonmail.com>
.SH LICENSE
MIT License. See LICENSE file for details.
.SH SEE ALSO
.BR vim (1),
.BR nvim (1),
.BR sqlite3 (1)