💻 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.

🧑‍💻 Run from source

To run or develop the version of PLS-CLI in a cloned repository, install Python 3.9+ and uv, then run:

git clone <your-repository-url>
cd pls-cli
uv sync --only-group test
uv run pls --help

uv sync creates a project-local .venv environment from pyproject.toml and uv.lock. The .venv directory should not be committed; it can be recreated from those files.

Verify changes

Run the automated tests before sharing a change:

uv run pytest -q

⬆️ 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:

echo 'pls' >> ~/.bashrc

echo 'pls' >> ~/.zshrc

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

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

echo 'pls' >> ~/.tcshrc

echo 'pls' >> ~/.xonshrc

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.

Insert a task

Insert a task after an existing task by using its current ID:

pls insert 2 "third task"

This inserts third task after task 2. Tasks that were after task 2 automatically receive their new displayed IDs. Task names with spaces must be wrapped in quotes.

The ID must be an existing task ID, from 1 through the current number of tasks. Inserting into an empty list, using 0, or using an ID beyond the last task displays an error.

PLS-CLI asks for confirmation before changing the list. Enter y to insert and save the task, or N to leave the list unchanged.

🎨 Color Configuration

You can configure all colors with envs!!

export PLS_ERROR_LINE_STYLE="#e56767"

$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"

export PLS_QUOTE_STYLE="#a0a0a0 on blue"

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

💄 Formatting a task

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:

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