apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-06-26 15:39:40 +02:00
Code Issues Projects Releases Packages Wiki Activity

update quickstart with install.sh instructions

Browse source
This commit is contained in:
Adil Hafeez 2026-03-23 00:22:30 +00:00
parent 0ee45e7084
commit 944cddd9a6
1 changed files with 5 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/source/get_started/quickstart.rst
View file

@ -17,10 +17,9 @@ Follow this guide to learn how to quickly set up Plano and integrate it into you
Prerequisites Prerequisites
------------- -------------
Plano runs **natively** by default — no Docker or Rust toolchain required. Pre-compiled binaries are downloaded automatically on first run. Plano runs **natively** by default — no Docker or Python required. Pre-compiled binaries are downloaded automatically on first run.
1. `Python <https://www.python.org/downloads/>`_ (v3.10+) Supported platforms: Linux (x86_64, aarch64), macOS (Apple Silicon)
2. Supported platforms: Linux (x86_64, aarch64), macOS (Apple Silicon)
**Docker mode** (optional): **Docker mode** (optional):
@ -29,29 +28,13 @@ If you prefer to run inside Docker, add ``--docker`` to ``planoai up`` / ``plano
1. `Docker System <https://docs.docker.com/get-started/get-docker/>`_ (v24) 1. `Docker System <https://docs.docker.com/get-started/get-docker/>`_ (v24)
2. `Docker Compose <https://docs.docker.com/compose/install/>`_ (v2.29) 2. `Docker Compose <https://docs.docker.com/compose/install/>`_ (v2.29)
Plano's CLI allows you to manage and interact with the Plano efficiently. To install the CLI, simply run the following command: **Install the Plano CLI**
.. tip::
We recommend using **uv** for fast, reliable Python package management. Install uv if you haven't already:
.. code-block:: console
$ curl -LsSf https://astral.sh/uv/install.sh | sh
**Option 1: Install planoai with uv (Recommended)**
.. code-block:: console .. code-block:: console
$ uv tool install planoai==0.4.14 $ curl -fsSL https://raw.githubusercontent.com/katanemo/plano/main/install.sh | bash
**Option 2: Install with pip (Traditional)** This downloads the latest ``planoai`` binary and installs it to ``~/.plano/bin/``. Follow the on-screen instructions to add it to your PATH.
.. code-block:: console
$ python -m venv venv
$ source venv/bin/activate # On Windows, use: venv\Scripts\activate
$ pip install planoai==0.4.14
.. _llm_routing_quickstart: .. _llm_routing_quickstart: