apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-05-27 14:17:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

add dev install instructions to quickstart and contributing guide

Browse source
This commit is contained in:
Adil Hafeez 2026-03-23 00:43:34 +00:00
parent 944cddd9a6
commit e4af53a8ae
2 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md
View file

@ -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