From e4af53a8aee7a620c0e14216f1825b848a24a6c3 Mon Sep 17 00:00:00 2001 From: Adil Hafeez Date: Mon, 23 Mar 2026 00:43:34 +0000 Subject: [PATCH] add dev install instructions to quickstart and contributing guide --- CONTRIBUTING.md | 15 +++++++++------ docs/source/get_started/quickstart.rst | 7 +++++++ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f9b0b9c..c1f570de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,18 +61,21 @@ The pre-commit hooks will automatically run: - Linting checks (Rust with `cargo clippy`) - Rust unit tests -### 5. Setup the planoai CLI +### 5. Build the planoai CLI -The planoai CLI is used to build, run, and manage Plano locally: +The planoai CLI is used to build, run, and manage Plano locally. Build it from source: ```bash -cd cli -uv sync +cd crates && cargo build --release -p plano-cli ``` -This creates a virtual environment in `.venv` and installs all dependencies. +Then add it to your PATH: -Now you can use `planoai` commands from anywhere, or use `uv run planoai` from the `cli` directory. +```bash +export PATH="$(pwd)/crates/target/release:$PATH" +``` + +Add the export line to your `~/.bashrc` or `~/.zshrc` to make it permanent. You can now use `planoai` commands from anywhere. ### 6. Create a Branch diff --git a/docs/source/get_started/quickstart.rst b/docs/source/get_started/quickstart.rst index e002a3ad..7e323976 100644 --- a/docs/source/get_started/quickstart.rst +++ b/docs/source/get_started/quickstart.rst @@ -36,6 +36,13 @@ If you prefer to run inside Docker, add ``--docker`` to ``planoai up`` / ``plano This downloads the latest ``planoai`` binary and installs it to ``~/.plano/bin/``. Follow the on-screen instructions to add it to your PATH. +**Building from source** (for contributors): + +.. code-block:: console + + $ cd crates && cargo build --release -p plano-cli + $ export PATH="$(pwd)/target/release:$PATH" + .. _llm_routing_quickstart: