pedantic.software repositories

traf - traf: a CLI, UNIX-y, minimal kanban board

References

BranchCommitAuthorDate
masterfixes + improve git discoverySylvain Gauthier2022-10-25 10:48
 

About

Demo

traf is a simple and elegant way of managing your TODO-list, per project or globally.

Tasks are simple files split between todo, wip and done folders within a .traf directory. The name of the file is the identifier of the task, a simple integer that gets incremented with every new task, and the content is the title of the task with an optional description.

Marking a task todo, wip or done is thus simply a matter of moving the task file from one folder to the other.

When traf is called, it will first look for a .traf directory starting from the current directory, going through all parent directories until it finds one or / is reached, similarly to git.

Git can be used to sync tasks between computers and team members.

How-to

Dependencies

It requires choice to display/filter entries.

Install

git clone https://pedantic.software/git/traf
cd traf
sudo ./install.sh

You can specify a PREFIX if you want to install it in a different directory than the default (/usr).

Init

When in the root directory of a project you wish to create a new traf listing for, simply type:

traf init

This will create the .traf directory. To init git tracking as well, type:

traf git init

Optionally, to init traf from an already existing remote git repo, type:

traf init <git_repo_address>

Every time you create a new traf project, its location will be appended to $HOME/.traprojs, so that traf can also list all tasks in all projects at once.

New task

traf todo "Task description"

List tasks

Simply type traf.

More info

man traf