Skip to content

jkbdk/pls-cli

 
 

Repository files navigation

💻 PLS-CLI

If you are like me, and your terminal is your home, this CLI will make your life better, I hope 😄

🛠 Installation

pip install pls-cli

⬆️ Upgrade version

pip install pls-cli --upgrade

⚙️ Configuration

To run pls-cli everytime you open your shell's:

Details

Bash

echo 'pls' >> ~/.bashrc
Details

Zsh

echo 'pls' >> ~/.zshrc
Details

Fish

echo 'pls' >> ~/.config/fish/config.fish
Details

Ion

echo 'pls' >> ~/.config/ion/initrc
Details

Tcsh

echo 'pls' >> ~/.tcshrc
Details

Xonsh

echo 'pls' >> ~/.xonshrc
Details

Powershell

Add the following to the end of Microsoft.PowerShell_profile.ps1. You can check the location of this file by querying the $PROFILE variable in PowerShell. Typically the path is ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 or ~/.config/powershell/Microsoft.PowerShell_profile.ps1 on -Nix.

pls

⚠️ Restart your terminal to apply the changes and start configuring your PLS-CLI. 🎉

⌨️ Commands

pls --help

Or for more information you can see in the documentation.

🎨 Color Configuration

You can configure all colors with envs!!

Details

Setting env on Linux, macOS, Windows Bash:

export PLS_ERROR_LINE_STYLE="#e56767"
Details

Setting env on Windows PowerShell:

$Env:PLS_ERROR_LINE_STYLE = "#e56767"

All envs:

export PLS_ERROR_LINE_STYLE="#e56767"
export PLS_ERROR_TEXT_STYLE="#ff0000 bold"

export PLS_WARNING_LINE_STYLE="#FFBF00"
export PLS_WARNING_TEXT_STYLE="#FFBF00 bold"

export PLS_UPDATE_LINE_STYLE="#61E294"
export PLS_UPDATE_TEXT_STYLE="#61E294 bold"

export PLS_INSERT_DELETE_LINE_STYLE="#bb93f2"

export PLS_INSERT_DELETE_TEXT_STYLE="#a0a0a0"

export PLS_MSG_PENDING_STYLE="#61E294"
export PLS_TABLE_HEADER_STYLE="#d77dd8"
export PLS_TASK_DONE_STYLE="#a0a0a0"
export PLS_TASK_PENDING_STYLE="#bb93f2"
export PLS_HEADER_GREETINGS_STYLE="#FFBF00"
export PLS_QUOTE_STYLE="#a0a0a0"
export PLS_AUTHOR_STYLE="#a0a0a0"

export PLS_BACKGROUND_BAR_STYLE="bar.back"
export PLS_COMPLETE_BAR_STYLE="bar.complete"
export PLS_FINISHED_BAR_STYLE="bar.finished"
Details

You can specify the background color like this:

export PLS_QUOTE_STYLE="#a0a0a0 on blue"

If you create some theme, share with us here ♥️.

💄 Formatting a task

Details

You can format your tasks with:

pls add "[b]Bold[/], [i]Italic[/], [s]Strikethrough[/], [d]Dim[/], [r]Reverse[/], [red]Color Red[/], [#FFBF00 on green]Color exa with background[/], :star:, ✨"

image

🚧 TMUX integration

Using pls count-done and pls count-undone.

🤝 Special thanks

PLS-CLI stands on the shoulders of giants:

  • Typer for the CLI tool.
  • Rich for the beautiful formatting in terminal.

About

Minimalist and full configurable greetings and TODO list

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 93.6%
  • Makefile 6.2%
  • Shell 0.2%