guedesfelipe / pls-cli Goto Github PK

View Code? Open in Web Editor NEW

136.0 2.0 11.0 793 KB

Minimalist and full configurable greetings and TODO list

Home Page: https://guedesfelipe.github.io/pls-cli/

License: MIT License

Python 93.55% Makefile 6.26% Shell 0.20%

cli please pls python pythoncli todo todo-cli pls-cli command-line terminal hacktoberfest

pls-cli's Introduction

💻 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

⬆️ Upgrade version

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:

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

pls-cli's People

Contributors

Stargazers

Watchers

Forkers

sakthirathinam dmb23 alonmar andoresuperesu igor-simoes techwiz-3 cry-d anthonyraf astutesource wenbo-bao nawafalansari

pls-cli's Issues

Feature: possibility to choose tasks scope

I don't know if it's a good idea but sometimes I want to create tasks specifically for a unique project (inside a directory) so I propose to add a feature to set tasks scope, for example to start inside a directory you can just type pls init and all global tasks will not appear when I use pls tasks in the folder and its childs. So a settings file will be created inside the project directory.

Can't run pls

I'm installing pls at the second time and it gives me a error

Apparently it can't find the "pkg_resources" module and don't start

Running locally

Hey man, great work with this project.

I have a Python CLI project with a similar setup and I'm wondering how you test changes locally since you're importing the package pls_cli instead of importing the local files?

Hope that makes sense!
Thanks

Translation of quotes into other languages

Hello

Do you currently accept PR? I can help to be able to choose the language of the quotes
(maybe it will help in practicing other languages, who knows 🤷).
I can add this new feature and start translating in Spanish

Thanks for this nice tool 😊

categories on pls

Hello,

Currently i'm using todoist GUI, I'm using categories or projects, I see that is not possible manage categories by this i Think to used different configuration files, is this possible o what alternative can suggest for get this?

Thank you.

Move command should not swap

Hi,

Currently when using move command example move 7 1. It does a swap. But what I am looking for something like insert operation which inserts the element to that index and then reorders the below items . I did not find a way around for this. Do you think its possible or should we have a new options say insert ?

Thank you :)

`pls quotes`

What is the expected output for pls quotes? All I'm getting is this:

KeyError: 'tasks'

Hi there! 🚀

I installed pls-cli with the following steps:

pip install pls-cli -U.
echo 'pls' >> ~/.zshrc.
change my name: pls callme Orso.

Then I tried to add a task, as pls add "tester" and shooting this:

╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮
│ /Users/semora/opt/anaconda3/lib/python3.9/site-packages/pls_cli/please.py:181 in add             │
│                                                                                                  │
│   178 │   """[bold green]Add[/bold green] a Task :sparkles: [light_slate_grey italic](Add tas    │
│   179 │   new_task = {'name': task, 'done': False}                                               │
│   180 │   settings = Settings().get_settings()                                                   │
│ ❱ 181 │   settings['tasks'].append(new_task)                                                     │
│   182 │   Settings().write_settings(settings)                                                    │
│   183 │   center_print(                                                                          │
│   184 │   │   Rule(f'Added "{task}" to the list', style=insert_or_delete_line_style),            │
│                                                                                                  │
│ ╭─────────────────── locals ───────────────────╮                                                 │
│ │ new_task = {'name': 'tester', 'done': False} │                                                 │
│ │ settings = {'user_name': 'Orso'}             │                                                 │
│ │     task = 'tester'                          │                                                 │
│ ╰──────────────────────────────────────────────╯                                                 │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
KeyError: 'tasks'

could you tell me what I done wrong? 💥