1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-18 20:00:07 +00:00
ohmyzsh/plugins/catimg/README.md
Jacob Tomaw c130aadb6a Replace "restart shell" documentation "exec zsh" (#8411)
Running `source ~/.zshrc` can have side effects, it's better to reload the whole 
zsh session with `exec zsh`.
2019-11-19 19:44:00 +01:00

35 lines
745 B
Markdown

# catimg
Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg)
## Requirements
- `convert` (ImageMagick)
## Enabling the plugin
1. Open your `.zshrc` file and add `catimg` in the plugins section:
```zsh
plugins=(
# all your enabled plugins
catimg
)
```
2. Restart the shell or restart your Terminal session:
```console
$ exec zsh
$
```
## Functions
| Function | Description |
| -------- | ---------------------------------------- |
| `catimg` | Displays the given image on the terminal |
## Usage examples
[![asciicast](https://asciinema.org/a/204702.png)](https://asciinema.org/a/204702)