Download the PHP package keremardicli/php-tatr without Composer
On this page you can find all versions of the php package keremardicli/php-tatr. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download keremardicli/php-tatr
More information about keremardicli/php-tatr
Files in keremardicli/php-tatr
Package php-tatr
Short Description Task Tracker — git-friendly, file-based task management. PHP implementation of tsoding/tatr.
License GPL-2.0-only
Homepage https://github.com/KeremArdicli/php-tatr
Informations about the package php-tatr
php-tatr
php-tatr is a PHP port of tsoding/tatr — a git-friendly, file-based task tracker.
All credit for the original design, the on-disk task format, and the TQL (Task Query Language) goes to Alexey "tsoding" Kutepov and the tatr project. This repository is a from-scratch reimplementation of the same ideas in PHP, so it can be installed and used anywhere PHP and Composer are available, without needing a C compiler.
There is no database and no server. Every task is a plain TASK.md file, sitting in its own folder, inside a tasks/ directory that you commit to git alongside your code.
Why would I want this?
- Your tasks live next to your code, in the same git repository, so they travel with clones, branches, and pull requests.
- Every task is a plain text file, so
git log,git blame, andgit diffall work on your task history for free. - No servers, no accounts, no database — it's just files and a small CLI.
Requirements
- PHP 8.2 or newer
- Composer (to install the package)
You do not need to know PHP to use this tool. If you can run one command in a terminal, you can use tatr.
Installation
If you don't already have a PHP project, create an empty folder and initialize Composer in it first:
Then install php-tatr as a dev dependency — it's a workflow tool you run from the terminal, not something your application's code calls at runtime, so it belongs alongside things like PHPUnit rather than in production:
This downloads the tool into your project's vendor/ folder and creates a vendor/bin/tatr command you can run.
Running the tatr command
Every command below starts with:
On Windows, this also works from PowerShell or cmd.exe exactly the same way, as long as PHP is installed and on your PATH. If it isn't, you can always run it explicitly through PHP:
Tip: if you get tired of typing
vendor/bin/tatr, you can add an alias — on Mac/Linux,alias tatr="vendor/bin/tatr"; on Windows PowerShell,Set-Alias tatr vendor\bin\tatr. In the rest of this README we'll just writetatrfor brevity.
Quick start
That's it — a tasks/ folder now exists in your project, with one sub-folder per task. Commit it to git like any other file:
Commands
Run tatr help at any time to see this list from the CLI itself.
| Command | What it does |
|---|---|
tatr init |
Creates the tasks/ directory in the current folder |
tatr new [TITLE...] |
Creates a new task |
tatr ls [QUERY...] |
Lists tasks, optionally filtered by a TQL query |
tatr find <HUID> |
Finds a single task by its ID |
tatr summary |
Shows task counts grouped by tag |
tatr ref [HUID] |
Finds tasks that mention/reference a given task |
tatr untag -t <tag> [QUERY...] |
Removes a tag from matching tasks |
tatr graph |
Generates a graph.dot file showing how tasks reference each other |
tatr version |
Shows the tatr version |
tatr help |
Shows usage help |
Every command also accepts -help to print its own usage.
tatr init
Creates the tasks/ folder. Run this once per project, from the project's root folder.
tatr new — create a task
Flags:
-t <tags>— comma or space separated tags, e.g.-t bug,urgent-p <priority>— a number that controls sort order inls(default:100). By defaultlslists tasks with the highest priority number first; add-atolsto flip that around.-s <suffix>— appends a custom suffix to the generated task ID, useful if you create two tasks in the same second
Everything after the flags becomes the task title.
Each task is stored as tasks/<HUID>/TASK.md, where <HUID> (Human-Usable ID) is a timestamp like 20260914-082227. You can open and edit that TASK.md file directly in any text editor — it's just markdown.
tatr ls — list tasks
The part after the flags is a TQL (Task Query Language) query — see below.
tatr find — look up one task
tatr summary
tatr ref — find related tasks
If task A's TASK.md mentions task B's ID anywhere in its text, tatr ref on task B will list task A. Handy for tracking "this task depends on that one" style relationships without a rigid schema.
tatr untag — remove a tag in bulk
tatr graph
Scans every task for references to other task IDs and writes a graph.dot file (in the Graphviz DOT format) describing those connections. If you have Graphviz installed (specifically the neato command), it will also render graph.svg automatically. If not, you still get the .dot file and can render it later, or view it with any online DOT viewer.
The TQL query language
TQL (Task Query Language) is a tiny expression language used by tatr ls and tatr untag to filter tasks. You don't need to be a programmer to use it — think of it like search filters.
| Query | Meaning |
|---|---|
| (empty) | matches every task |
any |
matches every task (same as empty) |
:bug |
tasks tagged bug |
not :bug |
tasks not tagged bug |
:bug and :urgent |
tasks tagged both bug and urgent |
:bug or :feature |
tasks tagged bug or feature |
tagged |
tasks that have at least one tag |
not tagged |
tasks with no tags at all |
priority lt 50 |
tasks with priority less than 50 |
priority ge 100 |
tasks with priority greater than or equal to 100 |
20260914-082227 |
the single task with that exact ID |
[:bug or :feature] and priority lt 100 |
brackets group sub-expressions, just like in math |
Comparison keywords for priority: lt (less than), le (less than or equal), gt (greater than), ge (greater than or equal), eq (equal), ne (not equal).
Since these queries are just plain words, remember to quote them in your shell if they contain characters your shell treats specially, or simply pass them as separate arguments — tatr ls :bug and :urgent works fine without quotes because tatr joins all the trailing words back into one query internally.
The tasks/ folder format
Everything is plain text, so you can always edit files by hand if you want to:
A TASK.md file looks like this:
- The first
# Titleline is the task's title. - KEY: VALUElines are properties.STATUS,PRIORITY, andTAGSare understood by tatr; you can add your own custom properties too, and they'll be preserved.- Everything after the properties is free-form markdown — write whatever you like there.
An optional tasks/tags file lets you attach a human-readable description to each tag, shown by tatr summary:
Developing php-tatr itself
If you want to work on php-tatr's own source code (not just use it as a dependency):
The code is organized into three layers: src/Core/ (task parsing, rendering, and storage), src/Query/ (the TQL compiler and evaluator), and src/Command/ (one class per CLI command, dispatched from bin/tatr).
License
GPL-2.0-only, matching the license of the original tsoding/tatr project.