TUI for Todoist written with React+Ink.
Revise README: Add Quick Start and Features
Aly Raffauf
(Feb 11, 2026, 8:31 AM EST)
ad7bd8fd
7763552d
+41
-21
+41
-21
README.md
+41
-21
README.md
···
1
+
<div align="center">
2
+
1
3
# dewy
2
4
3
-
A TUI for Todoist built with Ink + React.js + Typescript.
5
+
A fast, minimal TUI for Todoist built with React.js + Ink + Typescript.
6
+
7
+
</div>
8
+
9
+
## Features
10
+
11
+
- **Filter views** — browse tasks by Todoist filter queries like `today`, `overdue`, or custom filters
12
+
- **Project views** — jump to any project by name
13
+
- **Quick add** — add tasks using Todoist's quick add syntax (dates, labels, projects all work)
14
+
- **Smart hints** — command suggestions appear as you type
15
+
- **XDG config** — simple JSON config at `~/.config/dewy/config.json`
4
16
5
17
## Install
6
18
7
19
```bash
8
-
$ npm install --global dewy
20
+
npm install --global dewy
9
21
```
10
22
11
-
## Usage
23
+
## Quick Start
12
24
13
-
```
14
-
$ dewy
15
-
```
25
+
1. Grab your API token from [Todoist settings](https://todoist.com/app/settings/integrations/developer)
16
26
17
-
## Configuration
27
+
2. Create your config file:
18
28
19
-
dewy uses a config file at `~/.config/dewy/config.json`:
20
-
21
-
```json
29
+
```bash
30
+
mkdir -p ~/.config/dewy
31
+
cat > ~/.config/dewy/config.json << 'EOF'
22
32
{
23
-
"apiToken": "your-todoist-api-token",
24
-
"homeFilter": "(today | overdue) & (assigned to: me | !assigned)"
33
+
"apiToken": "your-token-here"
25
34
}
35
+
EOF
26
36
```
27
37
38
+
3. Run it:
39
+
40
+
```bash
41
+
dewy
42
+
```
43
+
44
+
## Configuration
45
+
28
46
| Key | Type | Required | Description |
29
47
|-----|------|----------|-------------|
30
-
| `apiToken` | string | yes | Your Todoist API token |
31
-
| `homeFilter` | string | no | Custom Todoist filter to apply on the home view |
48
+
| `apiToken` | `string` | yes | Your Todoist API token |
49
+
| `homeFilter` | `string` | no | Todoist filter for the home view (default: `today`) |
32
50
33
51
## Commands
34
52
35
-
- `add <text>` - Add a new task via Todoist's QuickAdd
36
-
- `done <number>` - Complete a task by its number
37
-
- `refresh` - Reload tasks
38
-
- `project <name>` - View tasks in a project
39
-
- `today` - View today's tasks
40
-
- `home` - View the home filter
41
-
- `quit` - Exit
53
+
| Command | Description |
54
+
|---------|-------------|
55
+
| `add <task>` | Add a task via quick add |
56
+
| `done <number>` | Complete a task by its number |
57
+
| `project <name>` | View tasks in a project |
58
+
| `today` | View today's tasks |
59
+
| `home` | View the home filter |
60
+
| `refresh` | Reload tasks |
61
+
| `quit` | Exit |
42
62
43
63
## License
44
64