• This repository has been archived on 06/Oct/2021
  • Stars
    star
    123
  • Rank 290,145 (Top 6 %)
  • Language
    TypeScript
  • License
    GNU General Publi...
  • Created over 3 years ago
  • Updated about 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Yet another Obsidian task manager

tq

tq is a plugin for Obsidian for managing tasks using a file-based workflow. Each task is represented as a Markdown note with a single task line and some metadata in the frontmatter. Tasks are viewed by embedding queries in other notes, such as your Daily Note.

tq demo

An example task note:

---
due: '2021-06-30'
tags: 'work'
repeat: every Friday
completed:
  - '2021-06-18'
  - '2021-06-11'
---

- [ ] File TPS reports

This plugin is still under active development and is not yet feature complete. It does however have the basic functionality, and I'll be adding more as needed by my tasks workflow.

Custom Blocks

Tasks can be queried by using custom code blocks in notes. Here's an example which would include any tasks for the specified date or which are overdue (in relation to that date). It will also omit any tasks which have been completed.

```tq
select-day: 2021-06-06
completed:  false
overdue:    true
```

Or for a more complicated example:

```tq
select-week: 2021-06-13
select-tags: [ home, shopping ]
completed: false
group: due
no-due: true
```

Custom Block Properties

Property Value Description Default
select-day Date Include only tasks due this day All tasks
select-week Date Include only tasks due this week All tasks
select-tags String List Include only tasks with this tag (can be used with day/week) All tasks
omit-tags String List Exclude tasks with this tag (can be used with day/week) Omit none
overdue true/false Include if task is overdue in relation to selected day/week false
completed true/false Include only tasks which are checked or not checked. If completed is not provided, then both completed and incomplete tasks are shown. If set to true, then only completed tasks are shown, and if false then only incomplete tasks are shown. All tasks
due true/false Include tasks which have a due date true
no-due true/false Include tasks which do not have a due date true
sort "score", "due", "" Specify the sort order of the tasks ""
group "due", "completed", "" Specify how tasks should be grouped in the list ""

Note that select-tags and omit-tags support nested tags. In other words, select-tags: work will match notes tagged with work as well as work/meetings

Obsidian Links and Shortcuts

You may use Obsidian links to interact with tq from within or outside of the app.

Creating Tasks

obsidian://tq?create&due=2021-06-01&task=Water%20the%20garden

Properties must be URL escaped.

Property Value Description
action "create" Indicate a task is being created
due Date An optional due date for the task
task String The URL escaped contents of the task
repeat String The URL escaped repeat configuration
tags String Comma separated list of tags

Using iOS Shortcuts

The URL above can be used from iOS Shortcuts to create a quick way to add tasks from outside of Obsidian. Note however that if you are using Obsidian Sync, your task may not be synced unless you leave Obsidian open long enough to complete.

Example Shortcut

tq-shortcut.mp4

Pricing

This plugin is provided to everyone for free, however if you would like to say thanks or help support continued development, feel free to send a little my way through one of the following methods:

GitHub Sponsors Paypal BuyMeACoffee

Screenshots

So far the majority of my effort has been focused on functionality, so the UI has some very rough edges. It will hopefully improve over time!

create-task

edit task repeat

task details

More Repositories

1

advanced-tables-obsidian

Improved table navigation, formatting, and manipulation in Obsidian.md
TypeScript
2,073
star
2

ledger-obsidian

Plain text accounting in Obsidian.md
TypeScript
388
star
3

recent-files-obsidian

Display a list of most recently opened files
TypeScript
310
star
4

slated-obsidian

Task management in Obsidian.md
TypeScript
131
star
5

aenea-grammars

Custom commands for the Aenea voice control framework
Python
130
star
6

leader-hotkeys-obsidian

Use a leader-key (tmux style) for hotkeys in Obsidian.md
TypeScript
80
star
7

tw5-checklist

Simple checklist widget for TiddlyWiki5:
JavaScript
50
star
8

crumbs-obsidian

Breadcrumb navigation in Obsidian.md
TypeScript
26
star
9

metaledger

A collection of tools for Ledger, grouped into an easy to use Docker Compose script.
Shell
5
star
10

ledger-sqlite

Export ledger files into a SQLite database
Python
2
star
11

numericword

Convert a numeric value into English words in Go
Go
1
star
12

hledger-multiarch

A redistribution of hledger to provide a multiarch Docker container
Dockerfile
1
star
13

chicken-door

An arduino based automated chicken door
C++
1
star
14

Nomads-Sample-Drone

A sample drone that can be modified for use in nomads
Java
1
star
15

beginning-go

Created for the UW iSchool Workshop
Go
1
star
16

simple-file-server

Serve files over HTTP
Go
1
star
17

ScriptedPresenter

Stop copying and pasting commands during presentations. Use this template.
Shell
1
star
18

phone-number-normalizer

Converts phone numbers into standard +1 notation
Go
1
star
19

keyboards

Resources and designs for the custom keyboards I have created.
JavaScript
1
star
20

Audio-Shrinker

Very easily convert any flacs from an input directory into ogg vorbis in an output directory. Will recursively search through directory, mirroring the structure in the output directory.
Python
1
star
21

DotDeploy

Synchronize dotfiles on all your computers
JavaScript
1
star
22

Nomads

A fully automated exploration game
Java
1
star
23

metabase-multiarch

A redistribution of metabase to provide a multiarch Docker container
Dockerfile
1
star