Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guedesfelipe/pls-cli
Minimalist and full configurable greetings and TODO list
https://github.com/guedesfelipe/pls-cli
cli command-line hacktoberfest please pls pls-cli python pythoncli terminal todo todo-cli
Last synced: about 2 months ago
JSON representation
Minimalist and full configurable greetings and TODO list
- Host: GitHub
- URL: https://github.com/guedesfelipe/pls-cli
- Owner: guedesfelipe
- License: mit
- Created: 2022-06-17T14:41:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-01T14:40:28.000Z (6 months ago)
- Last Synced: 2024-08-09T10:02:25.346Z (3 months ago)
- Topics: cli, command-line, hacktoberfest, please, pls, pls-cli, python, pythoncli, terminal, todo, todo-cli
- Language: Python
- Homepage: https://guedesfelipe.github.io/pls-cli/
- Size: 774 KB
- Stars: 141
- Watchers: 2
- Forks: 13
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
💻 PLS-CLI
If you are like me, and your terminal is your home, this CLI will make your life better, I hope 😄
# 🛠 Installation
```sh
pip install pls-cli
```
# ⬆️ Upgrade version
```sh
pip install pls-cli --upgrade
```
# ⚙️ Configuration
To run **`pls-cli`** everytime you open your shell's:
Bash
```sh
echo 'pls' >> ~/.bashrc
```
Zsh
```sh
echo 'pls' >> ~/.zshrc
```
Fish
```sh
echo 'pls' >> ~/.config/fish/config.fish
```
Ion
```sh
echo 'pls' >> ~/.config/ion/initrc
```
Tcsh
```sh
echo 'pls' >> ~/.tcshrc
```
Xonsh
```sh
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.
```txt
pls
```
⚠️ Restart your terminal to apply the changes and start configuring your PLS-CLI. 🎉
# ⌨️ Commands
```sh
pls --help
```
Or for more information you can see in the [documentation](https://guedesfelipe.github.io/pls-cli/commands).
# 🎨 Color Configuration
You can configure all colors with envs!!
Setting env on Linux, macOS, Windows Bash:
```sh
export PLS_ERROR_LINE_STYLE="#e56767"
```
Setting env on Windows PowerShell:
```sh
$Env:PLS_ERROR_LINE_STYLE = "#e56767"
```
All envs:
```sh
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:
```sh
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:
```sh
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.
---
