Git Product home page Git Product logo

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 inforametion 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:, โœจ"

image

๐Ÿšง 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

guedesfelipe avatar dependabot[bot] avatar dmb23 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.