Something went wrong. Try again.
A git-based task manager
Something went wrong. Try again.
tsk readme
8.3 kB · 212 lines
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213tsk===
A fast & simple CLI task manager--------------------------------
The motivation for tsk is simple: make managing tasks as fast and easy aspossible with a focus on small, ephemeral tasks.
Secondary goals include:
- Provide the minimum amount of features necessary to be usable by a team- Support local and non-local workspaces- Be adaptable to almost any environment, even employer-mandated JIRA use- Be flexible, within reason
tsk takes inspiration from git and FORTH and is expected to be used alongsidethe former.
Dependencies------------
tsk is written in Rust. To compile from source, a recent Rust toolchain isrequired. As of now, it is developed using Rust 1.81.0.
Additionally, for fuzzy-finding functionality, the fzf command must be installedand in the shell's PATH.
https://github.com/junegunn/fzf
tsk workspaces must be created on filesystems that support symlinking.
Task-level metadata requires Linux's xattr(7) API and a filesystem that supportsit. Patches that implement this for other operating systems are welcome.
tsk expects to run on POSIX-like systems. Microsoft Windows and othernon-UNIX-ey operating systems will never be directly supported.
Installation------------
```shcargo install --locked tsk-cli```
Building--------
```shcargo install --path .```
Make sure ~/.cargo/bin is in your PATH.
Overview--------
A summary of commands and their functionality can be seen with:
tsk help
tsk uses plain text files for all of its functionality. A workspace is a folderthat contains a .tsk/ directory created with the `tsk init` command. Thepresence of a .tsk/ folder is searched recursively upwards until a filesystemboundary or root is encountered. This means you can nest workspaces and usefolders to namespace tasks while also using tsk commands at any location withina workspace.
New tasks are created with the `tsk push` command. A title is always required,but can be modified later. A unique identifier is selected automatically and afile with the title and any body contents supplied are stored in the.tsk/archive folder. A symlink is then created in the .tsk/tasks folder markingthe task as "open." The task is then added to the top of the "stack" by havingits tsk-ID and title added to the .tsk/index file.
The contents of the stack may be printed using the `tsk list` command.
Tasks are marked as "completed" and removed from the index with the `tsk drop`command. They will remain in the .tsk/archive folder, but are excluded fromfuzzy searches by default.
The priority of a task may be manipulated in any of several ways:
`tsk swap` swaps the top two task on the stack
┌─────────┐ ┌─────────┐ │ tsk-100 │ │ tsk-102 │ └─────────┘ └─┬─────▲─┘ │ │ ┌─────────┐ ┌─▼─────┴─┐ │ tsk-102 │ ───────► │ tsk-100 │ └─────────┘ └─────────┘ ┌─────────┐ ┌─────────┐ │ tsk-108 │ │ tsk-108 │ └─────────┘ └─────────┘
`tsk rot` moves the 3rd task on the stack to the top of the stack and shiftsthe first and second down
┌─────────┐ ┌─────────┐ │ tsk-100 │ │ tsk-108 ◄─┐ └─────────┘ └────┬────┘ │ │ │ ┌─────────┐ ┌────▼────┐ │ │ tsk-102 │ ───────► │ tsk-100 │ │ └─────────┘ └────┬────┘ │ │ │ ┌─────────┐ ┌────▼────┐ │ │ tsk-108 │ │ tsk-102 ├─┘ └─────────┘ └─────────┘
`tsk tor` moves the task on the top of the stack behind the third, shifting thesecond and third tasks up.
┌─────────┐ ┌─────────┐ │ tsk-100 │ │ tsk-102 ├─┐ └─────────┘ └────▲────┘ │ │ │ ┌─────────┐ ┌────┴────┐ │ │ tsk-102 │ ───────► │ tsk-108 │ │ └─────────┘ └────▲────┘ │ │ │ ┌─────────┐ ┌────┴────┐ │ │ tsk-108 │ │ tsk-100 ◄─┘ └─────────┘ └─────────┘
`tsk prioritize` will take a selected task and move it to the top of the stackfrom any other position in the stack. It is selected either by ID or using fuzzyfinding.
`tsk deprioritize` moves a selected task to the bottom of the stack from anyposition.
Roadmap-------
- Configurable workspace-scoped prefix tags (tsk- vs example-)- Extended Attribute-based Metadata- Task Linking- IMAP4/SMTP-based synchronization and sharing- Export + sync with external task managers - GitLab - GitHub - JIRA - Obsidian - More?- tsk -> html export- Editor plugins - nvim-telescope - nvim - others?- Man page
Format------
The tsk text format can be thought of as a derivative of Markdown and scdoc, butnot quite either. Markdown is a great baseline for rich-text while scdocrestricts itself to rich text formatting that can be displayed effectively in aterminal. As tsk's primary goal is to be a fast, terminal-centric task manager,this property is a *must.*
Additionally, it should be similar enough to Markdown such that it is easy toexport to other applications, as outlined above in the roadmap.
Meanwhile, both Markdown and scdoc have some limitations and make choices that,while appropriate for their domain, are not appropriate for tsk. Some notabledifferences from both:
- There is only one way to do any type of formatting- Hard line breaks are real, not imaginary- Inline formatting control characters must be surrounded by space, newline, or common punctuation
A core feature of the format is *linking*. That is, references to other tasksutilizing wiki-link style links: `[[]]`. The content within the link is mappedto the local workspace if the `tsk-` prefix is used, or a mapped non-localworkspace if another prefix is used. These mappings are specified using a textfile within the .tsk folder.
A quick overview of the format:
- \!Bolded\! text is surrounded by exclamation marks (!)- \*Italicized\* text is surrounded by single asterisks (*)- \_Underlined\_ text is surrounded by underscores (_)- \~Strikethrough\~ text is surrounded by tildes (~)- \=Highlighted\= text is surrounded by equals signs (=)- \`Inline code\` is surrounded by backticks (`)
Links like in Markdown, along with the wiki-style links documented above.Raw links can also be written as \<https://example.com\>.
Misc----
tsk is heavily inspired by git. It mimics its folder structure and somecommands. The concept of the stack is inspired by FORTH and the observation thatmost of the time, only the top 3 priorities at any given moment matter and taskstend to be created when they are most important. This facilitates small,frequent creation of tasks that help both document problems and managefast-paced work environments.
tsk is not intended to be checked into git, however there is not a reason that itcannot be. This repository's development is managed using tsk itself.
Git does *not* track extended filesystem attributes. If you wish to avoid constantlyre-indexing, use something like metastore:
https://github.com/przemoc/metastore