Skip to main content

GTD + 12-Week Year CLI powered by Notion

Project description

The Getting Things Done Terminal User Interface

A TUI/CLI/API for personal productivity built around GTD (Getting Things Done).

What it does

  • Capture items to an inbox and triage them into projects
  • Track projects with contexts, next actions, and follow-up dates
  • Log completions and auto-reschedule recurring items
  • Defer, snooze, and review Someday/Maybe lists
  • Filter by context for focused work sessions

Requirements

Installation

cd gtd
uv sync
uv pip install -e .

This installs the gtd command.

Usage

Default: the TUI

gtd

With no subcommand, gtd launches the Textual TUI — tabs for Today, Next Steps, Inbox, Projects, Waiting For, Incubation, Recurring, Someday, and Lists, plus a guided Weekly Review. This is the primary interface.

CLI subcommands

Each of these also works standalone, e.g. for scripting or quick one-offs without opening the TUI:

Command Description
gtd init Set up or upgrade the GTD Notion database.
gtd triage Interactively process items needing triage.
gtd filter Filter by context name (e.g. gtd filter Phone).
gtd today Show actionable items for today.
gtd snooze Snooze today's items until tomorrow.
gtd log Log a note and reschedule a recurring item.
gtd done Mark a current project as done (archives it).
gtd review Run the GTD weekly review ritual.
gtd update Update fields on an existing project.
gtd defer Defer a project by setting a follow-up date.
gtd someday Review Someday/Maybe items — keep, activate, or drop.
gtd capture Quick-capture an item to the GTD inbox.
gtd areas Manage Areas of Focus (Notion 'Area' select options).
gtd areas add Add a new Area of Focus.
gtd areas remove Remove an Area of Focus.
gtd contexts Manage GTD contexts (Computer, Home, Phone, etc.).
gtd contexts add Add a new context.
gtd contexts remove Remove a context.
gtd contexts rename Rename a context and update all items with that context.
gtd dump Rapid-fire brain dump — capture everything, triage later.
gtd config View or set GTD configuration.
gtd config notes-editor Set notes editor: inline (TUI TextArea) or external (uses $EDITOR).
gtd fzf Launch the legacy fzf-based interactive GTD menu.
gtd tui Launch the interactive GTD TUI.
gtd api Start the GTD HTTP API server (requires: pip install gtd[api]).

Legacy fzf menu

gtd fzf

An older fzf-driven menu predating the TUI, kept for anyone who prefers it:

Category Action
Do Today
Do Log & Reschedule
Do Snooze until tomorrow
Do Capture new item
Do Brain dump
Do Triage inbox
Manage Update project
Manage Defer project until date
Manage Waiting For
Manage Mark done (delete)
Review Weekly Review
Review Review Someday/Maybe
View View all projects
View Filter by context

HTTP API

A small Flask app (gtd api) exposes GTD operations over HTTP, primarily so you can drive gtd from iOS Shortcuts (or any other HTTP client) without opening a terminal — capture a thought, check today's actionable items, or triage the inbox from your phone.

There's no central server in the loop: you run this yourself, against your own Notion integration and database. Your GTD data lives in your Notion account under your own token.

Install: uv pip install "gtd[api]" Run: gtd api (default 0.0.0.0:8000) or gtd api --port 9000 Auth: Bearer token — set GTD_API_KEY on the server, then pass Authorization: Bearer <key> on every request.

Method Path Description
POST /capture Add an item to the inbox. Body: {"header": "..."}.
GET /contexts Get active contexts.
GET /inbox Get all Triage entries (inbox).
GET /list-categories Return canonical list categories from Notion (for debugging/UI use).
GET /list/<category> Get all entries in a specific list category.
GET /next-steps Get actionable next steps, optionally filtered by context.
GET /triage-schema Get schema for triage workflow: statuses and contexts per status.
POST /triage/<page_id> Atomically triage an entry with full data.

Updating this README

The fzf menu table, CLI command table, project tree, and HTTP API table above are all extracted from source: cli.py's menu_items list and click command tree, module docstrings under src/gtd/ and scripts/, and the @app.get/@app.post/... routes in api.py, respectively. After changing any of these, regenerate everything:

python scripts/update_readme.py

A pre-commit hook (sync-readme) runs this automatically whenever any src/gtd/**/*.py, scripts/**/*.py, or README.md file changes, so these sections shouldn't drift in practice.

Data storage

  • GTD: Notion database (configured via gtd init or NOTION_NOTES_TOKEN / NOTION_PROJECTS_DB_ID env vars)
  • Weekly review state, Areas of Focus, list categories: JSON files in ~/.local/share/gtd/

Project structure

src/gtd/
├── api.py          # Thin Flask wrapper around GTD Notion operations for iOS Shortcuts.
├── cli.py          # GTD CLI — David Allen's Getting Things Done powered by Notion.
├── gtd_tui.py      # Unified GTD TUI.
├── storage.py      # Local JSON I/O for weekly review state and habit dates.
├── tui.py          # Shared Textual widgets and modals for the GTD TUI.
├── ui.py           # fzf helpers, prompts, and formatting shared across CLI commands.
└── notion/
    ├── capture.py  # Quick-capture items to the GTD inbox (Notion Projects table).
    ├── client.py   # Notion REST API client (httpx).
    ├── commands.py # Manage commands: mark done, defer, waiting for, notion dispatch.
    ├── config.py   # Configuration management for GTD CLI.
    ├── display.py  # Display formatting for Notion entries.
    ├── entries.py  # Entry listing, selection, and field editing.
    ├── init.py     # Database initialization and schema management for GTD CLI.
    ├── log.py      # Log, reschedule, and recurring-item utilities.
    ├── models.py   # Parse Notion page properties into simple data structures.
    ├── review.py   # Weekly review and Someday/Maybe review flows.
    ├── schema.py   # GTD Notion database schema definition — single source of truth.
    ├── today.py    # Today view and snooze commands.
    └── triage.py   # Interactive triage flow for processing inbox items.
scripts/
├── check_commit_msg_early.py # Validate the commit message during the *pre-commit* stage, not commit-msg.
└── update_readme.py          # Update README.md menu, CLI, tree, and HTTP API sections from source.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gtd_tui-0.2.0.tar.gz (85.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gtd_tui-0.2.0-py3-none-any.whl (69.2 kB view details)

Uploaded Python 3

File details

Details for the file gtd_tui-0.2.0.tar.gz.

File metadata

  • Download URL: gtd_tui-0.2.0.tar.gz
  • Upload date:
  • Size: 85.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for gtd_tui-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6c2ea140c825c323cbb376944cf7c932bb0bcdf5821800b94a0c5553a7c43322
MD5 169df968797b43e831d7b005391480c4
BLAKE2b-256 5938890a11314af83f3b8c3075305da9f4b7cb2cb9c4382535fe31a5b6ea5394

See more details on using hashes here.

Provenance

The following attestation bundles were made for gtd_tui-0.2.0.tar.gz:

Publisher: publish.yml on dannybrown37/gtd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gtd_tui-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: gtd_tui-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 69.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for gtd_tui-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c94263853529de2d96580ab40ae7374108103906a692cb07a82dbbe0ae0dc726
MD5 4b4365ef83039081704a669901d785d7
BLAKE2b-256 4b448ec1f090b5e32ffec6741944ecc2d013eb494715edb378ab912c4a93be70

See more details on using hashes here.

Provenance

The following attestation bundles were made for gtd_tui-0.2.0-py3-none-any.whl:

Publisher: publish.yml on dannybrown37/gtd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page