https://github.com/bdougherty/jumper-message-cli
A helpful message for times when it’s a bad idea to do something.
https://github.com/bdougherty/jumper-message-cli
cli
Last synced: 6 months ago
JSON representation
A helpful message for times when it’s a bad idea to do something.
- Host: GitHub
- URL: https://github.com/bdougherty/jumper-message-cli
- Owner: bdougherty
- License: mit
- Created: 2018-03-02T04:29:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T00:05:44.000Z (over 3 years ago)
- Last Synced: 2025-04-10T08:12:16.938Z (over 1 year ago)
- Topics: cli
- Language: JavaScript
- Homepage:
- Size: 1.3 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
```
┓┏┓┏┓┃
┛┗┛┗┛┃ ⟍ ○⟋
┓┏┓┏┓┃ ∕ jumper
┛┗┛┗┛┃ ノ) message
┓┏┓┏┓┃ cli
┃┃┃┃┃┃
┻┻┻┻┻┻
```
## Install
```
$ npm install --global jumper-message-cli
```
## Usage
```
$ jumper-message --help
Usage
$ jumper-message
$ echo | jumper-message
Options
--floors Number of additional floors to add (Default: 0)
--compact Remove extra spacing between message lines (Default: false)
--gradient Render the text as a gradient (Default: none)
--building-style Chalk style string for the building (Default: gray)
--message-style Chalk style string for the message (Default: bold.white)
--person-style Chalk style string for the person (Default: white)
Examples
jumper-message 'Friday deploy, good luck!'
jumper-message 'Friday deploy, good luck!' --gradient=rainbow
jumper-message 'Friday deploy, good luck!' --floors=4
jumper-message 'Friday deploy, good luck!' --compact --message-style=bold.red.bgWhite
```
Style arguments use the [chalk style syntax](https://github.com/chalk/chalk#styles).
Gradients are provided by the [gradient-string](https://github.com/bokub/gradient-string) package. Available gradients are:
[](https://github.com/bokub/gradient-string#available-built-in-gradients)
Message style and gradients cannot be combined. If a gradient is specified, it will override the message style.
## Related
* [jumper-message](https://github.com/bdougherty/jumper-message) - API for this module
* [chalk](https://github.com/chalk/chalk)
* [gradient-string](https://github.com/bokub/gradient-string)
## License
MIT © [Brad Dougherty](https://brad.is)