README
¶
tjek
A keyboard-driven task manager for the terminal that tells you what to do next.
tjek runs on Linux, macOS and Windows and keeps everything in a local file. It can sync between your machines through a small server you run yourself. No account, no cloud service.
What it does
- Ranks your tasks. Deadline, priority, recent work, size and age decide
the order, and a task that blocks something urgent rises with it. Press
wto see why a task ranks where it does. - Holds the details. Due and start dates, priority, size, tags, projects, subtasks, dependencies, comments, notes and repeating tasks.
- Adds in one line.
Buy milk #shopping due:friday p:high @home - Shows the same tasks five ways: a list, a calendar with tracked time, projects with a timeline, tags, and a kanban board. Plus a stats page.
- Tracks time. Start and stop a timer on a task with
t. - Reminds you daily with a desktop notification of what's due and overdue.
- Syncs between computers, undoes every change, and has a command
palette (
ctrl+k) and a command line for scripting. - Speaks English, Danish and German, with themes and rebindable keys.
Install
| macOS | brew install iliorn/tap/tjek |
| Windows | scoop install https://github.com/Iliorn/tjek/releases/latest/download/tjek.json |
| Linux / Windows binary | Releases |
| Anywhere Go runs | go install github.com/Iliorn/tjek@latest |
tjek updates itself from Settings → "Update to latest release". docs/install.md covers building from source and verifying a download.
Getting started
Run tjek.
| Key | Action |
|---|---|
a |
Add task |
d |
Done |
enter |
Details: comments, subtasks, dependencies, notes |
t |
Start/stop the timer |
D |
Set the due date |
/ |
Search |
f |
Focus on today and overdue |
u |
Undo |
tab / 1–7 |
Switch tab |
? |
Every key |
ctrl+k |
Find any action by name |
#tag, @project, due:friday, p:high and s:l fill in a new task, and
the same words search: / then @work overdue shows your overdue work tasks.
Dates can be today, tomorrow, monday, +3d, -2d, 15-06-25 and more.
Learn more
- Using tjek: every tab, search, the board, reminders and custom keys
- Command line:
tjek add,list,done, JSON output, export and import - Sync between devices: running a server and connecting your machines
- Files and troubleshooting: where data lives, backups, crashes
- Changelog
Contributing
CONTRIBUTING.md covers building and testing, and ARCHITECTURE.md how tjek is put together. Security issues go through SECURITY.md.
License
MIT
Documentation
Source Files
¶
- atomicfile.go
- board.go
- board_carry.go
- boardsync.go
- cache.go
- cli.go
- cli_add.go
- cli_diagnose.go
- cli_edit.go
- cli_lifecycle.go
- cli_query.go
- cli_refs.go
- cli_show.go
- cli_suggest.go
- cli_sync_recover.go
- cli_time.go
- completion.go
- console.go
- console_other.go
- constants.go
- crash.go
- export.go
- exportsettings.go
- faststyle.go
- focus.go
- former.go
- groups.go
- helpers.go
- input.go
- input_other.go
- keymap.go
- keys.go
- lang.go
- lang_input.go
- lastadded.go
- layout.go
- main.go
- migration_002.go
- migration_011.go
- migrator.go
- model.go
- model_layout.go
- notify.go
- notify_other.go
- palette.go
- reminder.go
- repository.go
- selectors.go
- serve.go
- servetls.go
- storage.go
- storage_sqlite.go
- store.go
- styles.go
- suggest.go
- syncadopt.go
- syncauto.go
- syncclient.go
- synclive.go
- syncserver.go
- syncsettings.go
- syncstore.go
- synctoken.go
- taskops.go
- timerrecover.go
- trace.go
- undo_persist.go
- update.go
- update_board.go
- update_detail.go
- update_modes.go
- version.go
- view.go
- view_board.go
- view_calendar.go
- view_detail.go
- view_explain.go
- view_lists.go
- view_preview.go
- watcher.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Package paths decides where tjek keeps its files.
|
Package paths decides where tjek keeps its files. |
|
Package rank is the sequencing engine: the rule that decides the "Sequence" sort order and the value persisted in the todos.sequence column on every save.
|
Package rank is the sequencing engine: the rule that decides the "Sequence" sort order and the value persisted in the todos.sequence column on every save. |
|
Package tasksync is tjek's cross-device sync engine: the pure merge fold (Merge), the wire protocol (Request/Response, PostSync), the HTTP endpoint (Server), the real-time change push (Hub, Listener), and conflict detection (DroppedLocalEdits).
|
Package tasksync is tjek's cross-device sync engine: the pure merge fold (Merge), the wire protocol (Request/Response, PostSync), the HTTP endpoint (Server), the real-time change push (Hub, Listener), and conflict detection (DroppedLocalEdits). |
|
Package todo is tjek's framework-free domain layer: the Todo type and its mutations (toggle, tags, timers, subtasks, comments, time entries).
|
Package todo is tjek's framework-free domain layer: the Todo type and its mutations (toggle, tags, timers, subtasks, comments, time entries). |
Click to show internal directories.
Click to hide internal directories.