Skip to main content

Encrypted monthly CLI todo manager with shell-session passphrase cache

Project description

todoctl

A CLI-first, encrypted monthly todo manager for nerdy engineers and architects.


Overview

todoctl is designed for people who prefer:

  • terminal-first workflows
  • structured but lightweight task tracking
  • full control over their data
  • encryption by default

It is not a replacement for a team collaboration tool. It is a personal productivity tool.


Features

  • 🔐 Password-based encryption (scrypt + ChaCha20-Poly1305)
  • 📅 Monthly task separation
  • 🧠 Status-driven workflow (OPEN, DOING, SIDE, DONE)
  • 🧾 Stable task IDs
  • 🧹 Automatic sorting
  • ✍️ Native vim / $EDITOR editing
  • 🧩 Shell integration (auto-installed)
  • ⚡ Shell completion (auto-installed)
  • 🔄 Session-based password caching
  • 💾 Backup support
  • 🧼 Clean uninstall (todo purge --uninstall)

Installation (macOS & Linux – user-wide)

The recommended way to install todoctl is via pipx. This works on both macOS and Linux and installs the tool user-wide.


1. Install pipx

macOS:

brew install pipx
pipx ensurepath

Ubuntu / Debian:

sudo apt update
sudo apt install pipx
pipx ensurepath

Reload your shell:

exec $SHELL

2. Install todoctl

From PyPI (recommended):

pipx install todoctl

Or directly from GitHub:

pipx install git+https://github.com/epik0r/todoctl.git

3. Verify installation

todo --help


Notes

  • The todo command is installed into:

    ~/.local/bin

  • If the command is not found:

    pipx ensurepath exec $SHELL

  • pipx uses isolated environments internally, but for you the tool behaves like a normal global CLI.


Installation dev

python3 -m venv .venv
source .venv/bin/activate
pip install -e .

First Run Behavior

On the first real todo command (e.g. todo init), the tool automatically installs:

  • shell session integration
  • shell completion (bash or zsh)
  • vim integration (if vim or vi is available)

⚠️ Important: Shell completion will only be active after:

  • opening a new terminal, or
  • reloading your shell config:
source ~/.bashrc
# or
source ~/.zshrc

Usage

Initialize

todo init

List tasks

todo list
todo list 03
todo list 2026-03

Edit tasks (recommended workflow)

todo edit

Add a task

todo add "Implement API integration"

Change status

todo doing 1
todo done 1
todo open 1
todo side 1

Remove a task

todo remove 3

Rollover tasks

todo rollover 03 04

Backup

todo backup

Doctor

todo doctor

Purge

todo purge --yes
todo purge --yes --uninstall

todoctl – Vim Integration

Filetype Detection

  • Automatically detects .todo files
  • Sets filetype=todoctl

Syntax Highlighting

  • Highlights:
    • Header
    • Task IDs
    • Comments
  • Status colors:
    • OPEN (green)
    • DOING (yellow)
    • SIDE (blue)
    • DONE (gray)

Status Visualization (Conceal)

  • Displays symbols instead of text:
    • OPEN → ○
    • DOING → ▶
    • SIDE → ◆
    • DONE → ✔

Status Editing

  • Press t to cycle status: OPEN → DOING → SIDE → DONE → OPEN

Folding by Status

  • Tasks grouped automatically by status

Controls

  • z → toggle current block
  • gZ → close all
  • O → open all

Editor Settings

  • nowrap
  • nospell
  • commentstring=# %s

Security Model

  • scrypt + ChaCha20-Poly1305
  • no plaintext storage
  • session-scoped cache

Session Cache

  • valid per shell
  • expires after TTL (default 8h)
  • no cross-terminal sharing

Troubleshooting

cat ~/.local/share/todoctl/bootstrap.log

License

GPLv3

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

todoctl-1.0.5.tar.gz (38.0 kB view details)

Uploaded Source

Built Distribution

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

todoctl-1.0.5-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

Details for the file todoctl-1.0.5.tar.gz.

File metadata

  • Download URL: todoctl-1.0.5.tar.gz
  • Upload date:
  • Size: 38.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for todoctl-1.0.5.tar.gz
Algorithm Hash digest
SHA256 dd59673aeee37847a1d61d7c23b76129acc4a52ef46c9e83ccc7529991eb6683
MD5 2c11e577090da772d65ba2c3e8d831cd
BLAKE2b-256 0f430c4bb0f00a1128e03efc6734b5490f642bfc3130274c4dcf017dbfce3c7f

See more details on using hashes here.

Provenance

The following attestation bundles were made for todoctl-1.0.5.tar.gz:

Publisher: python-publish.yml on epik0r/todoctl

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

File details

Details for the file todoctl-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: todoctl-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 39.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for todoctl-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 89cfc0cc30c1c524a2ca128ab7a6460d5910cd32050749cfde68fff5435c623f
MD5 6907be40edf13bd36f419f9d85d31172
BLAKE2b-256 8573e1b241fdf32b0be892781c43d0b641d10e4655f760369179388ad143947b

See more details on using hashes here.

Provenance

The following attestation bundles were made for todoctl-1.0.5-py3-none-any.whl:

Publisher: python-publish.yml on epik0r/todoctl

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