.. program:: kitty +kitten icat


.. highlight:: sh
.. code-block:: sh

  kitty +kitten icat [options] image-file ...

A cat like utility to display images in the terminal. You can specify multiple image files and/or directories. Directories are scanned recursively for image files.

Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. option:: --align <ALIGN>

    Horizontal alignment for the displayed image.
    Default: :code:`center`
    Choices: :code:`center, left, right`

.. option:: --place <PLACE>

    Choose where on the screen to display the image. The image will be scaled to fit into the specified rectangle. The syntax for specifying rectangles is <:italic:`width`>x<:italic:`height`>@<:italic:`left`>x<:italic:`top`>. All measurements are in cells (i.e. cursor positions) with the origin :italic:`(0, 0)` at the top-left corner of the screen.

.. option:: --scale-up

    When used in combination with :option:`--place` it will cause images that are smaller than the specified area to be scaled up to use as much of the specified area as possible.

.. option:: --clear

    Remove all images currently displayed on the screen.

.. option:: --transfer-mode <TRANSFER_MODE>

    Which mechanism to use to transfer images to the terminal. The default is to auto-detect. :italic:`file` means to use a temporary file and :italic:`stream` means to send the data via terminal escape codes. Note that if you use the :italic:`file` transfer mode and you are connecting over a remote session then image display will not work.
    Default: :code:`detect`
    Choices: :code:`detect, file, stream`

.. option:: --detect-support

    Detect support for image display in the terminal. If not supported, will exit with exit code 1, otherwise will exit with code 0 and print the supported transfer mode to stderr, which can be used with the :option:`--transfer-mode` option.

.. option:: --detection-timeout <DETECTION_TIMEOUT>

    The amount of time (in seconds) to wait for a response form the terminal, when detecting image display support.
    Default: :code:`10`

.. option:: --print-window-size

    Print out the window size as :italic:`widthxheight` (in pixels) and quit. This is a convenience method to query the window size if using kitty icat from a scripting language that cannot make termios calls.

