Skip to content

Latest commit

 

History

History
161 lines (138 loc) · 3.93 KB

README.md

File metadata and controls

161 lines (138 loc) · 3.93 KB
Raw

Taskbook.go

Tasks, boards & notes for the terminal 🚀🚀🚀

demo.mp4

Overview

  • Create tasks & notes in different boards
  • View timeline of tasks & notes
  • Filter by boards
  • Respects XDG env
  • Configurable colors (TOML)
  • Archive and restore tasks & notes
  • Tab-complete arguments

Table of Contents

Installation

Requirements

Needs Nerd Fonts to render icons correctly.

AUR

Use your favorite AUR helper or makepkg to install.

paru -S tb.go

or

yay -S tb.go

or

#Manual
git clone https://aur.archlinux.org/tb.git
cd tb
makepkg -si

Git

git clone https://github.com/araaha/tb.go
cd tb.go
make
make sys-install

Binary releases

You can download binaries from here:

Usage

Quickstart

Create a task via tb task. You can begin tasks, or complete them. Alternatively tb note creates a note. All items are stored in a taskbook.json file stored in

  • $XDG_DATA_HOME
  • $HOME/.local/share/taskbook

in that order.

Deleting tasks archives them. To permanently remove them, run tb archive --remove. tb clear clears every completed task and places them in the archive. For further information, run tb --help to see all commands. For each subcommand, you can run --help for that flag to see examples.

Shell Completion

  • bash 
    #Set up completion for tb
eval "$(tb completion bash)"
  • zsh 
    #Set up completion for tb
source <(tb completion bash)```
  • fish 
    #Set up completion for tb
tb completion fish | source
  • powershell 
    #Set up completion for tb
tb completion powershell | Out-String | Invoke-Expression```

Config

The config file is stored in TOML. You can specify one with the --config flag. Alternatively, it searches in

  • $XDG_CONFIG_HOME/taskbook/taskbook.toml
  • $HOME/.config/taskbook/taskbook.toml in that order.

Example

#Gruvbox
[colors]
white = "#ebdbb2"
red = "#fb4934"
yellow = "#fabd2f"
gray = "#928374"
green = "#b8bb26"
blue = "#83a598"
magenta = "#d3869b"
cyan = "#8ec07c"

You can specify the colors in hex format.

Commands

tb help

A Taskbook

Usage:
  tb [flags]
  tb [command]

Available Commands:
  archive     Display archived items
  begin       Begin/pause task
  check       Check/uncheck task
  clear       Delete all checked items
  completion  Generate the autocompletion script for the specified shell
  delete      Delete item
  edit        Edit item description
  help        Help about any command
  list        List items by board
  move        Move item between boards
  note        Create note
  priority    Update priority of task
  restore     Restore items from archive
  star        Star/unstar item
  task        Create task
  timeline    Display timeline view

Flags:
      --config string   config file (default is $XDG_CONFIG_HOME/taskbook/taskbook.toml)
  -h, --help            help for tb
  -v, --version         Display current version

Use "tb [command] --help" for more information about a command.

Comparison

Compared to taskbook:

  • tb.go respects $XDG env
  • Shell-completion (via cobra)
  • You can specify which colors to use
  • Much more performant due to being compiled
  • Uses Nerd Fonts icons

Thanks to

  • taskbook - this project was heavily inspired by this one