Skip to content

markelca/prioritty

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

132 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

prioritty

A Terminal User Interface (TUI) and CLI application for managing your tasks. Focused on:

  • Good looks
  • Performance
  • Nice defaults
  • Customization
  • Autocompletion support

Peek 2025-06-09 18-58


Configuration

You can configure the tool with the config command, or by modifying the configuration yaml file. You can also provide a filepath to use another config (pt --config ./config.yaml)

config.yaml:

database_path: "./data/prioritty.db"
log_file_path: "./logs/prioritty.log"
default_command: "tui"
editor: vim
repository_type: sqlite  # or "obsidian"

Repository Types

Prioritty supports two storage backends:

  • sqlite (default): Traditional SQLite database storage
  • obsidian: Store items as markdown files in an Obsidian vault

To use an Obsidian vault:

repository_type: obsidian
database_path: /path/to/your/obsidian-vault

Or via environment variables:

export PRIORITTY_REPOSITORY_TYPE=obsidian
export PRIORITTY_DATABASE_PATH=/path/to/your/obsidian-vault

When using the Obsidian backend, each task/note is stored as a markdown file with YAML frontmatter in the vault root directory.

Usage

CLI

Run the help command to find out the usage:

A Terminal User Interface (TUI) and CLI application for managing your tasks. Focused on:
	- Good looks
	- Performance
	- Nice defaults
	- Customization
	- Autocompletion support

Usage:
  pt [flags]
  pt [command]

Available Commands:
  cancel      Mark tasks as cancelled
  completion  Generate the autocompletion script for the specified shell
  config      Show current configuration
  done        Mark tasks as done
  edit        Edit a task or note by index
  help        Help about any command
  list        Shows all the tasks
  note        Adds a new note
  remove      Removes one or more tasks by ID
  show        Show task or note details by index
  start       Mark tasks as in progress
  tag         Sets the tag for one or more tasks
  tags        Lists all available tags
  task        Adds a new task
  todo        Mark tasks as todo
  tui         Launch the interactive TUI
  version     Print the version number of Hugo

Flags:
      --config string   config file (default is $HOME/.cobra.yaml)
      --demo            Use a temporal demo database with predefined values
  -h, --help            help for pt

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

TUI

You can also press the ? key to toggle the full help in TUI mode: image

Frontmatter Syntax

When creating or editing items (via pt task, pt note, pt edit, or pressing e/a in the TUI), the editor opens with YAML frontmatter format:

Task example:

---
title: Complete project report
type: task
status: in-progress
tag: work
---
Optional body/description here.
Can span multiple lines.

Note example:

---
title: Meeting notes
type: note
tag: work
---
Note content here.

Supported fields:

Field Description Values
title Item title (required) Any text
type Item type task or note
status Task status (tasks only) todo, in-progress, done, cancelled
tag Single tag name Any text

You can view an item's raw frontmatter with pt show <index> --raw.

Autocompletion

To enable shell autocompletion for pt, add the appropriate line to your shell configuration:

Bash

# Add to your ~/.bashrc
source <(pt completion bash)

Zsh

# Add to your ~/.zshrc
source <(pt completion zsh)

Fish

# Add to your fish config
source (pt completion fish | psub)

PowerShell

# Add to your PowerShell profile
Invoke-Expression (pt completion powershell | Out-String)

Inspired by taskbook

About

Task list and productivity tool in the terminal

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages