kitty - Binary install
========================

.. |ins| replace:: curl -L :literal:`https://sw.kovidgoyal.net/kitty/installer.sh` | sh /dev/stdin

.. highlight:: sh

You can install pre-built binaries of |kitty| if you are on macOS or Linux using
the following simple command:

.. parsed-literal::
    :class: pre

    |ins|


The binaries will be installed in the standard location for your OS,
:file:`/Applications/kitty.app` on macOS and :file:`~/.local/kitty.app` on
Linux. The installer only touches files in that directory.


Manually installing
---------------------

If something goes wrong or you simply do not want to run the installer, you can
manually download and install |kitty| from the `GitHub releases page
<https://github.com/kovidgoyal/kitty/releases>`_. If you are on macOS, download
the :file:`.dmg` and install as normal. If you are on Linux, download the tarball
and extract it into a directory. The |kitty| executable will be in the
:file:`bin` sub-directory.

Ubuntu/Debian (Gnome Shell) installing
---------------------

.. code-block:: sh

    curl -L https://sw.kovidgoyal.net/kitty/installer.sh | sh /dev/stdin
    curl https://sw.kovidgoyal.net/kitty/_static/kitty.png --output ~/.local/share/applications/kitty.png
    echo -e "[Desktop Entry]\nEncoding=UTF-8\nName=Kitty\nExec=/home/$USER/.local/kitty.app/bin/kitty\nIcon=/home/$USER/.local/share/applications/kitty.png\nType=Application\nCategories=Application;" >> ~/.local/share/applications/kitty.desktop
    

Customizing the installation
--------------------------------

* You can specify a different install location, with ``dest``:

  .. parsed-literal::
     :class: pre

     |ins| \\
         dest=/some/other/location

* You can tell the installer not to launch |kitty| after installing it with
  ``launch=n``:

  .. parsed-literal::
     :class: pre

     |ins| \\
         launch=n

* You can use a previously downloaded dmg/tarball, with ``installer``:

  .. parsed-literal::
     :class: pre

     |ins| \\
         installer=/path/to/dmg or tarball

Uninstalling
----------------

All the installer does is copy the kitty files into the install directory
(defaults to :file:`~/.local/kitty.app`). To uninstall, simply delete that
directory.


Building from source
------------------------

|kitty| is easy to build from source, follow the :doc:`instructions <build>`.