Skip to content

Commit f8f503c

Browse files
Xatterclaude
andcommitted
docs: rename todo references to taskleef in README
Update CLI command examples from `todo` to `taskleef`, rename completion files from todo-completion to taskleef-completion. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 75cbbac commit f8f503c

3 files changed

Lines changed: 44 additions & 44 deletions

File tree

README.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ TASKLEEF_API_KEY=your-api-key-here
4141

4242
Then use the `--auth-file` flag:
4343
```bash
44-
todo --auth-file ~/.taskleef.auth list
45-
todo -a ~/.taskleef.auth list
44+
taskleef --auth-file ~/.taskleef.auth list
45+
taskleef -a ~/.taskleef.auth list
4646
```
4747

4848
This is useful for managing multiple accounts or keeping credentials separate.
@@ -56,21 +56,21 @@ export TASKLEEF_API_URL=https://your-server.com
5656

5757
### Optional: Command Alias
5858

59-
If you prefer using `tl` instead of `todo`, add this alias to your `~/.bashrc` or `~/.zshrc`:
59+
If you prefer using `tl` instead of `taskleef`, add this alias to your `~/.bashrc` or `~/.zshrc`:
6060
```bash
61-
alias tl=todo
61+
alias tl=taskleef
6262
```
6363

6464
## Tab Completion
6565

6666
### Bash
6767
```bash
68-
source /path/to/taskleef/todo-completion.bash
68+
source /path/to/taskleef/taskleef-completion.bash
6969
```
7070

7171
### Zsh
7272
```bash
73-
source /path/to/taskleef/todo-completion.zsh
73+
source /path/to/taskleef/taskleef-completion.zsh
7474
```
7575

7676
Add the appropriate line to your `~/.bashrc` or `~/.zshrc` to enable completion on startup.
@@ -132,100 +132,100 @@ See the [full API documentation](https://taskleef.com/docs) for all 39 available
132132
### Global Options
133133

134134
```bash
135-
todo [--auth-file <path>] <command> [args]
136-
todo [-a <path>] <command> [args]
135+
taskleef [--auth-file <path>] <command> [args]
136+
taskleef [-a <path>] <command> [args]
137137
```
138138

139139
### Basic Commands
140140

141141
```bash
142142
# List pending todos
143-
todo list
144-
todo ls
143+
taskleef list
144+
taskleef ls
145145

146146
# List all todos (including completed)
147-
todo list -a
147+
taskleef list -a
148148

149149
# Add a new todo
150-
todo add "Buy groceries"
150+
taskleef add "Buy groceries"
151151

152152
# Quick add (without 'add' keyword)
153-
todo "Buy groceries"
153+
taskleef "Buy groceries"
154154

155155
# Show a todo with details and subtasks
156-
todo show <title-or-id>
156+
taskleef show <title-or-id>
157157

158158
# Mark a todo as complete
159-
todo complete <title-or-id>
160-
todo done <title-or-id>
159+
taskleef complete <title-or-id>
160+
taskleef done <title-or-id>
161161

162162
# Delete a todo
163-
todo delete <title-or-id>
164-
todo rm <title-or-id>
163+
taskleef delete <title-or-id>
164+
taskleef rm <title-or-id>
165165
```
166166

167167
### Inbox
168168

169169
```bash
170170
# List todos not assigned to any project
171-
todo inbox
171+
taskleef inbox
172172
```
173173

174174
### Subtasks
175175

176176
```bash
177177
# Add a subtask to a todo
178-
todo subtask <parent-title-or-id> "Subtask title"
178+
taskleef subtask <parent-title-or-id> "Subtask title"
179179
```
180180

181181
### Projects
182182

183183
```bash
184184
# List all projects
185-
todo project list
185+
taskleef project list
186186

187187
# Create a new project
188-
todo project add "Project Name"
188+
taskleef project add "Project Name"
189189

190190
# Show project with its todos
191-
todo project show <project-name-or-id>
191+
taskleef project show <project-name-or-id>
192192

193193
# Delete a project
194-
todo project delete <project-name-or-id>
194+
taskleef project delete <project-name-or-id>
195195

196196
# Add a todo to a project
197-
todo project add-todo <project-name-or-id> <todo-title-or-id>
197+
taskleef project add-todo <project-name-or-id> <todo-title-or-id>
198198

199199
# Remove a todo from a project
200-
todo project remove-todo <project-name-or-id> <todo-title-or-id>
200+
taskleef project remove-todo <project-name-or-id> <todo-title-or-id>
201201
```
202202

203203
### Boards (Kanban)
204204

205205
```bash
206206
# Show default board (ASCII view)
207-
todo board
207+
taskleef board
208208

209209
# List all accessible boards
210-
todo board list
210+
taskleef board list
211211

212212
# Show a specific board with columns and cards
213-
todo board show <board-name-or-id>
213+
taskleef board show <board-name-or-id>
214214

215215
# List cards in a specific column
216-
todo board column <column-name-or-id>
216+
taskleef board column <column-name-or-id>
217217

218218
# Move a card to a different column
219-
todo board move <card-title-or-id> <column-name-or-id>
219+
taskleef board move <card-title-or-id> <column-name-or-id>
220220

221221
# Mark a card as done in its current column
222-
todo board done <card-title-or-id>
222+
taskleef board done <card-title-or-id>
223223

224224
# Assign a card to the current user
225-
todo board assign <card-title-or-id>
225+
taskleef board assign <card-title-or-id>
226226

227227
# Delete all cards in a column
228-
todo board clear <column-name-or-id>
228+
taskleef board clear <column-name-or-id>
229229
```
230230

231231
### Interactive TUI
@@ -238,8 +238,8 @@ Launch a full-screen terminal UI with an interactive kanban board.
238238

239239
```bash
240240
# Open the TUI (starts with board picker)
241-
todo tui
242-
todo t
241+
taskleef tui
242+
taskleef t
243243
```
244244

245245
**Board picker**: `↑/↓` to select, `Enter` to open, `q` to quit.
@@ -260,7 +260,7 @@ todo t
260260

261261
Cards are grouped by status within each column (Active, Blocked, Done) and all are navigable.
262262

263-
## Finding Todos, Projects, and Boards
263+
## Finding todos, projects, and boards
264264

265265
Commands that accept an identifier support:
266266

@@ -271,29 +271,29 @@ Commands that accept an identifier support:
271271

272272
```bash
273273
# Add a todo
274-
$ todo add "Review pull request"
274+
$ taskleef add "Review pull request"
275275
Created: Review pull request (a1b2c)
276276

277277
# List todos
278-
$ todo ls
278+
$ taskleef ls
279279
Pending todos:
280280

281281
○ a1b2c Review pull request
282282
● d3e4f 2024-01-15 Fix login bug
283283

284284
# Complete a todo by title
285-
$ todo done "pull request"
285+
$ taskleef done "pull request"
286286
Completed: Review pull request
287287

288288
# Create a project and add todos
289-
$ todo project add "Website Redesign"
289+
$ taskleef project add "Website Redesign"
290290
Created project: Website Redesign (x7y8z)
291291

292-
$ todo project add-todo "Website" "Fix login"
292+
$ taskleef project add-todo "Website" "Fix login"
293293
Added todo to project: Website Redesign
294294

295295
# View a kanban board
296-
$ todo board
296+
$ taskleef board
297297
┌─────────────┬─────────────┬─────────────┐
298298
│ Backlog │ In Progress │ Done │
299299
├─────────────┼─────────────┼─────────────┤
@@ -302,7 +302,7 @@ $ todo board
302302
└─────────────┴─────────────┴─────────────┘
303303

304304
# Move a card to a different column
305-
$ todo board move "Feature A" "Done"
305+
$ taskleef board move "Feature A" "Done"
306306
Moved: Feature A -> Done
307307
```
308308

0 commit comments

Comments
 (0)