Installation
============

Requirements
------------

* Python 3.10 or later
* Git
* Optional: ``fuse-overlayfs`` for overlay filesystem worktree isolation

Installing from Source
----------------------

Install directly from GitHub using pip:

.. code-block:: console

   $ pip install https://github.com/whot/papagai

Development Installation
------------------------

For development, clone the repository and use `uv <https://github.com/astral-sh/uv>`_:

.. code-block:: console

   $ git clone https://github.com/whot/papagai
   $ cd papagai
   $ uv run papagai --help

Optional Dependencies
---------------------

Rich Logging
~~~~~~~~~~~~

For enhanced console output with rich formatting, install the ``rich`` package:

.. code-block:: console

   $ pip install rich

Overlay Filesystem Support
~~~~~~~~~~~~~~~~~~~~~~~~~~~

For overlay filesystem worktree isolation, install ``fuse-overlayfs``:

On Fedora/RHEL:

.. code-block:: console

   $ sudo dnf install fuse-overlayfs

On Ubuntu/Debian:

.. code-block:: console

   $ sudo apt install fuse-overlayfs

Verifying Installation
----------------------

After installation, verify that papagai is working:

.. code-block:: console

   $ papagai --help

You should see the help message with available commands.
