Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.

Latest commit

 

History

History
150 lines (102 loc) · 3.73 KB

README.md

File metadata and controls

150 lines (102 loc) · 3.73 KB
Raw

printr

printr is the smarter echo alternative. It is meant as a drop-in replacement of echo and has additional features like automatically guessing the sentiment of the string passed to it and then outputting it in the corresponding color.

Examples:

  1. A positive statement will be colored green.

    printr This is quite awesome!

  2. A negative statement will be colored red.

    printr Danger ahead!

  3. A neutral statement will be colored blue.

    printr Hello World...

For a full list of options and flags available, run printr --help.

Behind the scenes, printr performs some light sentiment analysis to guess whether a statement is positive, negative or neutral.

NOTE: This program does not work well with Windows CMD and Powershell. It works with Git-Bash.

A small demo

printr-image

Summary

Installing

printr comes packaged with a convenience install script that can run on all bash systems. Run the following command in your terminal (git-bash for windows users).

curl https://raw.githubusercontent.com/IgnisDa/printr/main/get-printr.sh -o get-printr.sh
# Warning: always examine scripts downloaded from the internet before running them locally.
bash get-printr.sh

The above command can also be used to update your current installation of printr.

print is also available on the AUR and can be installed using any AUR helper.

yay -S printr-git

Notes

Completions

The completions for printr are installed to /usr/share/doc/printr (or equivalent on Windows). They can be copied to the correct directories to enable tab completions.

NOTE: You may need to restart your shell in order for the changes to take effect.

Bash

You should have bash-completion installed.

cp /usr/share/doc/printr/printr.bash /etc/bash_completion.d/printr.bash-completion

Fish

cp /usr/share/doc/printr/printr.fish $HOME/.config/fish/completions/printr.fish

Zsh

cp /usr/share/doc/printr/_printr $HOME/.zfunc/_printr

You must then add the following line in your $HOME/.zshrc before compinit:

fpath+=~/.zfunc

For oh-my-zsh, you must then enable printr in your $HOME/.zshrc plugins

plugins(
   printr
   ...
   )

Miscellaneous

The output of printr -h is different from printr --help. The installation script also sets up man pages that can be accessed using man printr on non Windows systems.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache-2.0 - see the LICENSE.md file for details

Others

Project bootstrapped using cookiecutter by IgnisDa.