Daily project hygiene: keep README / CHANGELOG / TODO in sync with reality. LLM-first, algorithmic fallback.
Project description
taskill
AI Cost Tracking
- 🤖 LLM usage: $0.1500 (1 commits)
- 👤 Human dev: ~$200 (2.0h @ $100/h, 30min dedup)
Generated on 2026-04-25 using openrouter/qwen/qwen3-coder-next
Daily project hygiene: keep
README.md/CHANGELOG.md/TODO.mdin sync with reality. LLM-first, algorithmic fallback. Works standalone, in CI, or via Ansible.
taskill is the small daemon you stop forgetting to run. Once a day (or whenever metrics drift), it reads your git log, your SUMD.md / SUMR.md, your coverage report, and updates the three documentation files everyone tells themselves they'll keep current and never do.
It uses an LLM where one is available — Windsurf MCP first (because you're probably already running it in JetBrains), OpenRouter second — and falls back to a deterministic Conventional Commits parser when no LLM is reachable. The fallback is always available and always runs offline.
taskill deliberately doesn't replace pyqual, llx, or prefact. It calls them as subprocesses when configured, picks up their reports, and stays out of the way otherwise.
Install
pip install taskill # core
pip install "taskill[mcp]" # with Windsurf MCP support
pip install "taskill[mcp,schedule]" # with built-in scheduler
Quickstart
cd your-project/
taskill init # writes taskill.yaml + .env.example
cp .env.example .env # add OPENROUTER_API_KEY
taskill status # preview without running
taskill run --dry-run # see what would change
taskill run # do it
What it does
Every run produces three (idempotent) edits:
CHANGELOG.md— appends new entries under## [Unreleased], grouped by Conventional Commit type (### Added,### Fixed,### Performance, etc.). Uses Keep a Changelog layout. Existing entries are deduplicated.TODO.md— moves completed items to a## Done (moved to CHANGELOG)section, and appendsTODO:/FIXME:markers found in new commit bodies under## Discovered.README.md— refreshes only the block between<!-- taskill:status:start -->and<!-- taskill:status:end -->markers (HEAD, coverage, failing tests, summary). Never touches the rest of the file.
Provider chain
The chain runs top-to-bottom. First provider that's available and succeeds wins.
| Order | Provider | Used when |
|---|---|---|
| 1 | windsurf_mcp |
mcp package installed and a Windsurf endpoint resolves |
| 2 | openrouter |
OPENROUTER_API_KEY is set |
| 3 | algorithmic |
always — pure git-log + Conventional Commits parser |
You can reorder, disable, or pass options via taskill.yaml:
providers:
- name: openrouter # skip windsurf, go straight to OpenRouter
enabled: true
- name: algorithmic
enabled: true
Triggers
taskill run is a no-op unless one of the configured thresholds is crossed. State lives in .taskill/state.json so cron, GitHub Actions, and Ansible all share the same delta logic.
triggers:
min_hours_since_last_run: 24
min_commits_since_last_run: 1
changed_files_threshold: 1
coverage_change_pct: 2.0 # absolute pp; null to disable
failed_tests_changed: true
watch_files: [SUMD.md, SUMR.md]
require_all: false # OR by default; set true for AND
taskill run --force ignores triggers entirely.
Running it
Cron / systemd timer
0 6 * * * cd /path/to/project && /usr/local/bin/taskill run >> ~/.taskill.log 2>&1
GitHub Actions
See examples/github-action.yml. Triggers on push to main, runs taskill run, opens a PR if files changed.
GitLab CI
See examples/gitlab-ci.yml. Same idea, with merge-request creation via the GitLab API.
Ansible
See examples/ansible-playbook.yml. Useful for fleet-wide hygiene across many self-hosted repos.
CLI
taskill init # generate taskill.yaml + .env.example
taskill status # show what would happen, no writes
taskill run # execute (respects triggers)
taskill run --force # ignore triggers
taskill run --dry-run # don't write files or state
taskill run --json # machine-readable output
taskill release X.Y.Z # promote [Unreleased] → versioned heading
taskill clean-todo # wipe TODO.md (after a release)
Configuration reference
See taskill.yaml at the repo root for the annotated default config.
Reusing existing tools
taskill doesn't try to absorb pyqual / llx / prefact. It calls them by subprocess when toggled in reuse: and feeds their JSON output to the LLM as extra context:
reuse:
pyqual: true # taskill will run `pyqual report --json`
llx: false # ...add llx context (planned for v0.2)
prefact: false # ...add prefact suggestions (planned for v0.2)
If a tool isn't on PATH, taskill skips it silently — no hard dependency.
How it relates to the wider stack
SUMD (description) ─┐
├─→ taskill ──→ README.md
git log ────────────┤ CHANGELOG.md
pyqual report ──────┤ TODO.md
SUMR (state) ───────┘
taskill reads, never generates code. That's what prefact / llx / pyqual are for.
License
Licensed under Apache-2.0.
Status
Bootstrapped — no live project status yet. Will populate after first taskill run.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file taskill-0.1.2.tar.gz.
File metadata
- Download URL: taskill-0.1.2.tar.gz
- Upload date:
- Size: 171.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e2e16e1d468a79844c349adbf058f37ab06831308480472768e2f21e2602e855
|
|
| MD5 |
3731d15cc0d52bad379c11ef75bd1461
|
|
| BLAKE2b-256 |
534f8e16481f497223987cd227ea15e135f16210bf227c8fda80f6a337df7ac9
|
File details
Details for the file taskill-0.1.2-py3-none-any.whl.
File metadata
- Download URL: taskill-0.1.2-py3-none-any.whl
- Upload date:
- Size: 36.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d7d91ce1a10484861b075afb8a1e4e1100d3b6e5e18ff6669040af4e8420377
|
|
| MD5 |
4bf940e20516d14bde52e01b1d550cde
|
|
| BLAKE2b-256 |
9c85347ed144dcb6fa0f15864add4d57c329dcb0168eca71a15a35a725d6ddc9
|