tasksh(1)

✨ tasksh(1) ✨

okay bestie, pull up a chair because this is the manual page for tasksh — the Interactive taskwarrior shell 💅 and yes it's from the User Manuals collection, iykyk.

---

🎀 NAME 🎀

tasksh — Interactive taskwarrior shell 🦋

---

🌸 SYNOPSIS 🌸

tasksh
tasksh --version

---

💖 DESCRIPTION 💖

Tasksh is literally here to give you a way more immersive taskwarrior experience. The whole vibe? Any task command you'd run outside the shell? You can run it inside the shell too, except you don't have to prefix every single command with task. no cap. 🙌

When it's built with libreadline, tasksh hooks you up with command editing and history. the way that just works?? 😭✨

Tasksh also has an integrated review command that walks you through an interactive review session, like your own lil personal assistant. 🫶

And for the record: Tasksh supports all recent versions of Taskwarrior. periodt. 👑

---

🌈 COMMANDS 🌈

Tasksh supports the commands below. Everything else? It gets passed intact to Taskwarrior. no edits, no meddling. 💜

• diagnostics — Displays settings pertinent to tasksh, for diagnosing problems. your lil health check 🔍
• exec <commands> — Lets you run shell commands from inside Tasksh. Ideal for accessing man pages such as this one. You can use the ! command in place of the exec keyword. Once the command runs, control comes right back to Tasksh. 🎀
• exit/quit — These make tasksh terminate and drop you back into your system shell. bye bestie 👋
• help — Shows a summary of commands, and how to obtain help. 🧚
• review [N] — Begins an interactive review session, where you can mark tasks as reviewed, edit them using your text editor, provide modification commands, or skip them. You can terminate a review session at any time, and the next review session will resume at the right place. the resume feature?? iconic. ⭐

To find tasks needing review, the '_reviewed' custom report is created and run, which filters tasks that have a missing 'reviewed' UDA date, or have not been reviewed for a week.

This means that if you run a review session to completion, there will be no need to review again for a week, and the review command will simply do nothing until then. (yes, nothing. it's on break. 💀)

The one week review cycle is defined by the '_reviewed' custom report, which can be modified if you prefer a monthly review cycle.

If 'N' is provided, the session is limited to reviewing only N tasks.

Note: requires Taskwarrior 2.5.0 or later. For full details, see: <https://taskwarrior.org/docs/review.html>

---

🦋 USAGE 🦋

Here's an example tasksh session, bestie. look at her go 💅

$ tasksh
task> projects

Project Tasks Pri:None Pri:L Pri:M Pri:H
------- ----- -------- ----- ----- -----
            7        7     0     0     0
home        2        2     0     0     0
party       6        3     0     0     3

3 projects (15 tasks)
task> tags

Tag  Count
mall     2

1 tag (15 tasks)
task> list

ID Project Pri Due        Active Age   Description
---------------------------------------------------------------------
 2 party   H   10/17/2015        2 hrs Select and book a venue
 5 party   H   10/22/2015        2 hrs Design invitations
 9 home        10/31/2015         1 hr Pay rent
 3 party                         2 hrs Mail invitations
 4 party                         2 hrs Select a caterer
 6 party                         2 hrs Print invitations

8 tasks
task> quit
$

---

💜 CONFIGURATION 💜

Tasksh piggybacks on Taskwarrior's .taskrc configuration file, and refers to settings there. If you use a non-standard location for your .task database, and .taskrc file, Tasksh will not find them unless you set the TASKDATA and TASKRC environment variables. See man taskrc for more details. 🎀

The review command stores a UDA ('reviewed') and report definition ('_reviewed').

• tasksh.autoclear=1 — If set to "1", causes each tasksh command to be preceded by a 'clear screen' and cursor reset. Default is "0". ✨

---

👑 CREDITS & COPYRIGHTS 👑

Copyright (C) 2006 - 2017 P. Beckingham, F. Hernandez.

This man page was originally written by Federico Hernandez.

Tasksh is distributed under the MIT license. See <http://www.opensource.org/licenses/mit-license.php> for more information.

---

🌸 SEE ALSO 🌸

task(1),

For more information regarding tasksh, see the following:

• The official site at <http://taskwarrior.org/tools>
• The official code repository at <https://git.tasktools.org/scm/ex/tasksh.git>
• You can contact the project by emailing <support@tasktools.org>

---

😭 REPORTING BUGS 😭

Bugs in tasksh may be reported to the issue-tracker at <http://bug.tasktools.org>

---

okay that's the whole thing bestie, you're officially educated 💅✨ this was tasksh 1.2.0, dated 2017-05-10, and that's the tasksh(1) page, wrapped. go slay some tasks 🫶🎀💖