Skip to content

pipoprods/spaceship-taskwarrior

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

Taskwarrior + 🚀
Spaceship Section

A Taskwarrior section for Spaceship prompt

GitHub Release GitHub Workflow Status Spaceship Twitter Chat on Discord

This section shows an active task count indicator, tasks having "PENDING" or "in" tags.

Installing

You need to source this plugin somewhere in your dotfiles. Here's how to do it with some popular tools:

Execute this command to clone this repo into Oh-My-Zsh plugin's folder:

git clone https://github.com/pipoprods/spaceship-taskwarrior.git $ZSH_CUSTOM/plugins/spaceship-taskwarrior

Include spaceship-section in Oh-My-Zsh plugins list:

plugins=($plugins spaceship-section)
zplug "pipoprods/spaceship-taskwarrior"
antigen bundle "pipoprods/spaceship-taskwarrior"
antibody bundle "pipoprods/spaceship-taskwarrior"
zinit light "pipoprods/spaceship-taskwarrior"
zgen load "pipoprods/spaceship-taskwarrior"
[plugins.spaceship-taskwarrior]
github = "pipoprods/spaceship-taskwarrior"

Manual

If none of the above methods works for you, you can install Spaceship manually.

  1. Clone this repo somewhere, for example to $HOME/.zsh/spaceship-taskwarrior.
  2. Source this section in your ~/.zshrc.

Example

mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/pipoprods/spaceship-taskwarrior.git "$HOME/.zsh/spaceship-taskwarrior"

For initializing prompt system add this to your .zshrc:

source "~/.zsh/pipoprods/spaceship-taskwarrior.plugin.zsh"

Usage

After installing, add the following line to your .zshrc in order to include Ember section in the prompt:

spaceship add --before char debian_chroot

Options

This section is shown only when the $debian_chroot variable is set.

Variable Default Meaning
SPACESHIP_TASKWARRIOR_SHOW true Show current section
SPACESHIP_TASKWARRIOR_PREFIX $SPACESHIP_PROMPT_DEFAULT_PREFIX Prefix before section
SPACESHIP_TASKWARRIOR_SUFFIX $SPACESHIP_PROMPT_DEFAULT_SUFFIX Suffix after section
SPACESHIP_TASKWARRIOR_SYMBOL 🗹 Character to be shown before task count
SPACESHIP_TASKWARRIOR_COLOR #008080 Color of section

Contributing

First, thanks for your interest in contributing!

Contribute to this repo by submitting a pull request. Please use conventional commits, since this project adheres to semver and is automatically released via semantic-release.

License

MIT © Sébastien NOBILI

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages