plano/cli/README.md

77 lines
1.5 KiB
Markdown
Raw Normal View History

2025-12-23 18:37:58 -08:00
## Setup Instructions(User): plano CLI
2025-12-23 18:37:58 -08:00
This guide will walk you through the steps to set up the plano cli on your local machine
### Step 1: Create a Python virtual environment
In the tools directory, create a Python virtual environment by running:
```bash
python -m venv venv
```
### Step 2: Activate the virtual environment
* On Linux/MacOS:
```bash
source venv/bin/activate
```
### Step 3: Run the build script
```bash
2026-01-01 23:39:18 -08:00
pip install planoai==0.4.1
```
2025-12-23 18:37:58 -08:00
## Uninstall Instructions: plano CLI
```bash
2025-12-23 19:26:51 -08:00
pip uninstall planoai
```
2025-12-23 18:37:58 -08:00
## Setup Instructions (Dev): plano CLI
2025-12-23 18:37:58 -08:00
This guide will walk you through the steps to set up the plano cli on your local machine when you want to develop the plano CLI
2025-12-26 11:21:42 -08:00
### Step 1: Install uv
2025-12-26 11:21:42 -08:00
Install uv if you haven't already:
```bash
2025-12-26 11:21:42 -08:00
curl -LsSf https://astral.sh/uv/install.sh | sh
```
2025-12-26 11:21:42 -08:00
### Step 2: Create a Python virtual environment and install dependencies
In the cli directory, run:
```bash
2025-12-26 11:21:42 -08:00
uv sync
```
2025-12-26 11:21:42 -08:00
This will create a virtual environment and install all dependencies.
### Step 3: Activate the virtual environment (optional)
uv will automatically use the virtual environment, but if you need to activate it manually:
* On Linux/MacOS:
```bash
2025-12-26 11:21:42 -08:00
source .venv/bin/activate
```
### Step 4: build Arch
```bash
2025-12-26 11:21:42 -08:00
uv run planoai build
```
2024-10-10 17:44:41 -07:00
### Logs
2025-12-23 18:37:58 -08:00
`plano` command can also view logs from the gateway. Use following command to view logs,
2024-10-10 17:44:41 -07:00
```bash
2025-12-26 11:21:42 -08:00
uv run planoai logs --follow
```
2025-12-23 18:37:58 -08:00
## Uninstall Instructions: plano CLI
```bash
2025-12-23 19:26:51 -08:00
pip uninstall planoai