<h1 align="center">
💻 PLS-CLI
</h1>
<p align="center">
<a href="https://github.com/guedesfelipe/pls-cli/actions/workflows/ci.yml" target="_blank">
<img src="https://github.com/guedesfelipe/pls-cli/actions/workflows/ci.yml/badge.svg?branch=main" />
</a>
<a href="https://github.com/guedesfelipe/pls-cli/actions/workflows/security.yml" target="_blank">
<img src="https://github.com/guedesfelipe/pls-cli/actions/workflows/security.yml/badge.svg?branch=main" />
</a>
<a href="https://codecov.io/gh/guedesfelipe/pls-cli" >
<img src="https://codecov.io/gh/guedesfelipe/pls-cli/branch/main/graph/badge.svg"/>
</a>
<a href="https://pypi.org/project/pls-cli/" target="_blank">
<img src="https://img.shields.io/pypi/v/pls-cli?label=pypi%20package" />
</a>
<a href="" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/pls-cli.svg?color=green&logo=python&logoColor=yellow" />
</a>
<img src="https://img.shields.io/badge/platforms-windows%7C%20linux%7C%20macos-lightgrey" />
</p>
<p align="center">
<em>If you are like me, and your terminal is your home, this CLI will make your life better, I hope 😄</em>
<br>
<br>
<img src="https://user-images.githubusercontent.com/25853920/180621358-bf89cd86-2109-41e7-9fea-bbd1a6a56ff4.gif" />
</p>
# 🛠 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:
<details><p><summary>Bash</p></summary>
```sh
echo 'pls' >> ~/.bashrc
```
</details>
<details><p><summary>Zsh</p></summary>
```sh
echo 'pls' >> ~/.zshrc
```
</details>
<details><p><summary>Fish</p></summary>
```sh
echo 'pls' >> ~/.config/fish/config.fish
```
</details>
<details><p><summary>Ion</p></summary>
```sh
echo 'pls' >> ~/.config/ion/initrc
```
</details>
<details><p><summary>Tcsh</p></summary>
```sh
echo 'pls' >> ~/.tcshrc
```
</details>
<details><p><summary>Xonsh</p></summary>
```sh
echo 'pls' >> ~/.xonshrc
```
</details>
<details><p><summary>Powershell</p></summary>
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
```
</details>
⚠️ 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!!
<details><p><summary>Setting env on Linux, macOS, Windows Bash:</p></summary>
```sh
export PLS_ERROR_LINE_STYLE="#e56767"
```
</details>
<details><p><summary>Setting env on Windows PowerShell:</p></summary>
```sh
$Env:PLS_ERROR_LINE_STYLE = "#e56767"
```
</details>
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"
```
<details><p><summary>You can specify the background color like this:</p></summary>
```sh
export PLS_QUOTE_STYLE="#a0a0a0 on blue"
```
</details>
If you create some theme, share with us <a href="https://github.com/guedesfelipe/pls-cli/discussions/1#discussion-4174647" target="_blank">here</a> ♥️.
## 💄 Formatting a task
<details><p><summary>You can format your tasks with:</p></summary>
```sh
pls add "[b]Bold[/], [i]Italic[/], [s]Strikethrough[/], [d]Dim[/], [r]Reverse[/], [red]Color Red[/], [#FFBF00 on green]Color exa with background[/], :star:, ✨"
```
</details>
## 🚧 TMUX integration
Using `pls count-done` and `pls count-undone`.
## 🤝 Special thanks
**PLS-CLI** stands on the shoulders of giants:
* <a href="https://github.com/tiangolo/typer" target="_blank">Typer</a> for the CLI tool.
* <a href="https://github.com/Textualize/rich" target="_blank">Rich</a> for the beautiful formatting in terminal.
---
<p align="center">
<a href="https://ko-fi.com/guedesfelipe" target="_blank">
<img src="https://user-images.githubusercontent.com/25853920/175832199-6c75d866-31b8-4209-bd1a-db116a6dd032.png" width=300 />
</a>
</p>
Raw data
{
"_id": null,
"home_page": "https://guedesfelipe.github.io/pls-cli/",
"name": "pls-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "pls,please,todo,cli",
"author": "Felipe Guedes",
"author_email": "contatofelipeguedes@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c1/f3/209fdb253dbd8049f3e99f58d062a700d6211717fda9f10f91381b36e7a3/pls_cli-0.3.4.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n \ud83d\udcbb PLS-CLI\n</h1>\n<p align=\"center\">\n <a href=\"https://github.com/guedesfelipe/pls-cli/actions/workflows/ci.yml\" target=\"_blank\">\n <img src=\"https://github.com/guedesfelipe/pls-cli/actions/workflows/ci.yml/badge.svg?branch=main\" />\n </a>\n <a href=\"https://github.com/guedesfelipe/pls-cli/actions/workflows/security.yml\" target=\"_blank\">\n <img src=\"https://github.com/guedesfelipe/pls-cli/actions/workflows/security.yml/badge.svg?branch=main\" />\n </a>\n <a href=\"https://codecov.io/gh/guedesfelipe/pls-cli\" > \n <img src=\"https://codecov.io/gh/guedesfelipe/pls-cli/branch/main/graph/badge.svg\"/> \n </a>\n <a href=\"https://pypi.org/project/pls-cli/\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/pls-cli?label=pypi%20package\" />\n </a>\n <a href=\"\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/pyversions/pls-cli.svg?color=green&logo=python&logoColor=yellow\" />\n </a>\n <img src=\"https://img.shields.io/badge/platforms-windows%7C%20linux%7C%20macos-lightgrey\" />\n</p>\n\n<p align=\"center\">\n <em>If you are like me, and your terminal is your home, this CLI will make your life better, I hope \ud83d\ude04</em>\n <br>\n <br>\n <img src=\"https://user-images.githubusercontent.com/25853920/180621358-bf89cd86-2109-41e7-9fea-bbd1a6a56ff4.gif\" />\n</p>\n\n# \ud83d\udee0 Installation\n\n```sh\npip install pls-cli\n```\n\n# \u2b06\ufe0f Upgrade version\n\n```sh\npip install pls-cli --upgrade\n```\n\n# \u2699\ufe0f Configuration\n\nTo run **`pls-cli`** everytime you open your shell's:\n\n<details><p><summary>Bash</p></summary>\n\n```sh\necho 'pls' >> ~/.bashrc\n```\n\n</details>\n\n<details><p><summary>Zsh</p></summary>\n\n```sh\necho 'pls' >> ~/.zshrc\n```\n\n</details>\n\n<details><p><summary>Fish</p></summary>\n\n```sh\necho 'pls' >> ~/.config/fish/config.fish\n```\n\n</details>\n\n<details><p><summary>Ion</p></summary>\n \n```sh\necho 'pls' >> ~/.config/ion/initrc\n```\n\n</details>\n\n<details><p><summary>Tcsh</p></summary>\n \n```sh\necho 'pls' >> ~/.tcshrc\n```\n\n</details>\n\n<details><p><summary>Xonsh</p></summary>\n\n```sh\necho 'pls' >> ~/.xonshrc\n```\n</details>\n\n<details><p><summary>Powershell</p></summary>\n \nAdd 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.\n \n```txt\npls\n```\n\n</details>\n\n\u26a0\ufe0f Restart your terminal to apply the changes and start configuring your PLS-CLI. \ud83c\udf89\n\n# \u2328\ufe0f Commands\n\n```sh\npls --help\n```\n\nOr for more information you can see in the [documentation](https://guedesfelipe.github.io/pls-cli/commands).\n\n\n# \ud83c\udfa8 Color Configuration\n\nYou can configure all colors with envs!!\n\n<details><p><summary>Setting env on Linux, macOS, Windows Bash:</p></summary>\n\n```sh\nexport PLS_ERROR_LINE_STYLE=\"#e56767\"\n```\n\n</details>\n\n<details><p><summary>Setting env on Windows PowerShell:</p></summary>\n\n```sh\n$Env:PLS_ERROR_LINE_STYLE = \"#e56767\"\n```\n\n</details>\n\nAll envs:\n```sh\nexport PLS_ERROR_LINE_STYLE=\"#e56767\"\nexport PLS_ERROR_TEXT_STYLE=\"#ff0000 bold\"\n\nexport PLS_WARNING_LINE_STYLE=\"#FFBF00\"\nexport PLS_WARNING_TEXT_STYLE=\"#FFBF00 bold\"\n\nexport PLS_UPDATE_LINE_STYLE=\"#61E294\"\nexport PLS_UPDATE_TEXT_STYLE=\"#61E294 bold\"\n\nexport PLS_INSERT_DELETE_LINE_STYLE=\"#bb93f2\"\n\nexport PLS_INSERT_DELETE_TEXT_STYLE=\"#a0a0a0\"\n\nexport PLS_MSG_PENDING_STYLE=\"#61E294\"\nexport PLS_TABLE_HEADER_STYLE=\"#d77dd8\"\nexport PLS_TASK_DONE_STYLE=\"#a0a0a0\"\nexport PLS_TASK_PENDING_STYLE=\"#bb93f2\"\nexport PLS_HEADER_GREETINGS_STYLE=\"#FFBF00\"\nexport PLS_QUOTE_STYLE=\"#a0a0a0\"\nexport PLS_AUTHOR_STYLE=\"#a0a0a0\"\n\nexport PLS_BACKGROUND_BAR_STYLE=\"bar.back\"\nexport PLS_COMPLETE_BAR_STYLE=\"bar.complete\"\nexport PLS_FINISHED_BAR_STYLE=\"bar.finished\"\n```\n\n<details><p><summary>You can specify the background color like this:</p></summary>\n\n```sh\nexport PLS_QUOTE_STYLE=\"#a0a0a0 on blue\"\n```\n\n</details>\n\nIf you create some theme, share with us <a href=\"https://github.com/guedesfelipe/pls-cli/discussions/1#discussion-4174647\" target=\"_blank\">here</a> \u2665\ufe0f.\n\n## \ud83d\udc84 Formatting a task\n\n<details><p><summary>You can format your tasks with:</p></summary>\n\n```sh\npls add \"[b]Bold[/], [i]Italic[/], [s]Strikethrough[/], [d]Dim[/], [r]Reverse[/], [red]Color Red[/], [#FFBF00 on green]Color exa with background[/], :star:, \u2728\"\n```\n\n\n\n</details>\n\n## \ud83d\udea7 TMUX integration\n\nUsing `pls count-done` and `pls count-undone`.\n\n## \ud83e\udd1d Special thanks\n\n**PLS-CLI** stands on the shoulders of giants:\n\n* <a href=\"https://github.com/tiangolo/typer\" target=\"_blank\">Typer</a> for the CLI tool.\n* <a href=\"https://github.com/Textualize/rich\" target=\"_blank\">Rich</a> for the beautiful formatting in terminal.\n\n---\n\n<p align=\"center\">\n <a href=\"https://ko-fi.com/guedesfelipe\" target=\"_blank\">\n <img src=\"https://user-images.githubusercontent.com/25853920/175832199-6c75d866-31b8-4209-bd1a-db116a6dd032.png\" width=300 />\n </a>\n</p>\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Minimalist and full configurable greetings and TODO list",
"version": "0.3.4",
"project_urls": {
"Documentation": "https://guedesfelipe.github.io/pls-cli/",
"Homepage": "https://guedesfelipe.github.io/pls-cli/",
"Repository": "https://github.com/guedesfelipe/pls-cli"
},
"split_keywords": [
"pls",
"please",
"todo",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f564a9ef262457b9724b6fee017be2df35102cf165bd0bee9afe39d23f98eb6",
"md5": "ab6eba4296537efa6ef2cc5aa54c2fad",
"sha256": "f396f5a8e0dad142ee1610e7492a904f1a9462df3c1fa344d4d65cf7948d8bf3"
},
"downloads": -1,
"filename": "pls_cli-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab6eba4296537efa6ef2cc5aa54c2fad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 49564,
"upload_time": "2024-03-04T00:49:26",
"upload_time_iso_8601": "2024-03-04T00:49:26.557765Z",
"url": "https://files.pythonhosted.org/packages/3f/56/4a9ef262457b9724b6fee017be2df35102cf165bd0bee9afe39d23f98eb6/pls_cli-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1f3209fdb253dbd8049f3e99f58d062a700d6211717fda9f10f91381b36e7a3",
"md5": "70d0751289c5ec85dda74e71b005d847",
"sha256": "2019365d4666cbb7a7e83500a7ec9d2cb6f9d73294dcffe70a2e27eeb985e599"
},
"downloads": -1,
"filename": "pls_cli-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "70d0751289c5ec85dda74e71b005d847",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 49592,
"upload_time": "2024-03-04T00:49:27",
"upload_time_iso_8601": "2024-03-04T00:49:27.822849Z",
"url": "https://files.pythonhosted.org/packages/c1/f3/209fdb253dbd8049f3e99f58d062a700d6211717fda9f10f91381b36e7a3/pls_cli-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 00:49:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "guedesfelipe",
"github_project": "pls-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pls-cli"
}
JSON
