.editorconfig | ||
LICENSE.md | ||
README.md | ||
spaceship-taskwarrior.plugin.zsh |
Taskwarrior + 🚀
Spaceship Section
A Taskwarrior section for Spaceship prompt
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:
Oh-My-Zsh
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
zplug "pipoprods/spaceship-taskwarrior"
antigen
antigen bundle "pipoprods/spaceship-taskwarrior"
antibody
antibody bundle "pipoprods/spaceship-taskwarrior"
zinit
zinit light "pipoprods/spaceship-taskwarrior"
zgen
zgen load "pipoprods/spaceship-taskwarrior"
sheldon
[plugins.spaceship-taskwarrior]
github = "pipoprods/spaceship-taskwarrior"
Manual
If none of the above methods works for you, you can install Spaceship manually.
- Clone this repo somewhere, for example to
$HOME/.zsh/spaceship-taskwarrior
. - 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