💻 PLS-CLI
If you are like me, and your terminal is your home, this CLI will make your life better, I hope 😄
🛠 Installation
Recommended: Using pipx (isolated environment)
pipx installs the CLI in an isolated environment, avoiding conflicts with other packages:
# Install pipx if you haven't already
python3 -m pip install --user pipx
python3 -m pipx ensurepath
# Install pls-cli
pipx install pls-cli
Alternative: Using pip
pip install pls-cli
Note: Installing with pip may cause dependency conflicts with other packages. We recommend using pipx for CLI tools.
⬆️ Upgrade version
With pipx (recommended)
pipx upgrade pls-cli
With pip
pip install pls-cli --upgrade
⚙️ Configuration
To run pls-cli everytime you open your shell's:
Bash
echo 'pls' >> ~/.bashrc
Zsh
echo 'pls' >> ~/.zshrc
Fish
echo 'pls' >> ~/.config/fish/config.fish
Ion
echo 'pls' >> ~/.config/ion/initrc
Tcsh
echo 'pls' >> ~/.tcshrc
Xonsh
echo 'pls' >> ~/.xonshrc
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!!
Setting env on Linux, macOS, Windows Bash:
export PLS_ERROR_LINE_STYLE="#e56767"
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"
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
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:, ✨"
🚧 TMUX integration
Using pls count-done and pls count-undone.
🤝 Special thanks
PLS-CLI stands on the shoulders of giants:
