Skip to main content

No project description provided

Project description

💻 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

⚙️ 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

⌨️ Commands

pls --help
  add           Add a Task (Add task name inside quotes)
  clean         Clean up tasks marked as done
  clear         Clear all tasks
  count-done    Count done tasks
  count-undone  Count undone tasks
  delete        Delete a Task
  done          Mark a task as done
  move          Change task order
  setup         Reset all data and run setup
  showtasks     Show all Tasks
  undone        Mark a task as undone
  version       Show version

🎨 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="#844191"
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"

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:, ✨"

image

🚧 TMUX integration

Using pls count-done and pls count-undone.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pls-cli-0.1.1.tar.gz (48.7 kB view details)

Uploaded Source

Built Distribution

pls_cli-0.1.1-py3-none-any.whl (48.0 kB view details)

Uploaded Python 3

File details

Details for the file pls-cli-0.1.1.tar.gz.

File metadata

  • Download URL: pls-cli-0.1.1.tar.gz
  • Upload date:
  • Size: 48.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for pls-cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 62c67d37017b55027ff99c7f2d1bc0d7840f2667c29301996dbbd2fb88c59802
MD5 c3101332550129a590c00879272dba9e
BLAKE2b-256 77dc52cfe6878ab4c27fc702c6ef08616e54faae745464781f8d40a8b0483234

See more details on using hashes here.

File details

Details for the file pls_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pls_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 48.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for pls_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fb72f50df820c41d0968921aac54c08a142119167dc0e139d7273e1f7dd680ca
MD5 c2d7baa452ea8c9420fb6b2672bfa4a8
BLAKE2b-256 8b50c89780062721e2a2a2c81c9289593442bb836dc88daa3309c9fd78eff38f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page