github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/docs/commands/open-image.md (about)

     1  # `open-image`
     2  
     3  > Renders bitmap image data on your terminal
     4  
     5  ## Description
     6  
     7  `open-image` is an optional builtin which will render images (JPEG, GIF,
     8  PNG, BMP, TIFF and WebP) to the terminal using block characters and ANSI
     9  colour sequences.
    10  
    11  ## Usage
    12  
    13  ```
    14  <stdin> -> open-image -> <stdout>
    15  
    16  open-image file-path -> <stdout>
    17  ```
    18  
    19  ## Examples
    20  
    21  As a method
    22  
    23  ```
    24  » cat example.png -> open-image
    25  ```
    26  
    27  As a function
    28  
    29  ```
    30  » open-image example.png
    31  ```
    32  
    33  ## Detail
    34  
    35  `open-image` will fail if STDOUT is not a TTY.
    36  
    37  ## See Also
    38  
    39  * [`open`](../commands/open.md):
    40    Open a file with a preferred handler
    41  * [`qr`](../optional/qr.md):
    42    Creates a QR code from STDIN
    43  
    44  <hr/>
    45  
    46  This document was generated from [builtins/core/openimage/open-image_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/openimage/open-image_doc.yaml).