Skip to content

Commit e5ea3f9

Browse files
committed
update demo docs and comments to reflect native-first approach
1 parent c20b45a commit e5ea3f9

8 files changed

Lines changed: 42 additions & 45 deletions

File tree

config/test_passthrough.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
# that manage their own API key validation.
77
#
88
# To test:
9-
# docker build -t plano-passthrough-test .
10-
# docker run -d -p 10000:10000 -v $(pwd)/config/test_passthrough.yaml:/app/plano_config.yaml plano-passthrough-test
9+
# pip install planoai
10+
# planoai up config/test_passthrough.yaml
1111
#
1212
# curl http://localhost:10000/v1/chat/completions \
1313
# -H "Authorization: Bearer sk-your-virtual-key" \

demos/agent_orchestration/multi_agent_crewai_langchain/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,17 @@ Plano acts as a **framework-agnostic proxy and data plane** that:
3838
```bash
3939
# From the demo directory
4040
cd demos/agent_orchestration/multi_agent_crewai_langchain
41-
42-
# Build and start all services
43-
docker-compose up -d
41+
./run_demo.sh
4442
```
4543

46-
This starts:
47-
- **Plano** (ports 12000, 8001) - routing and orchestration
44+
This starts Plano natively and brings up via Docker Compose:
4845
- **CrewAI Flight Agent** (port 10520) - flight search
4946
- **LangChain Weather Agent** (port 10510) - weather forecasts
5047
- **AnythingLLM** (port 3001) - chat interface
5148
- **Jaeger** (port 16686) - distributed tracing
5249

50+
Plano runs natively on the host (ports 12000, 8001).
51+
5352
### Try It Out
5453

5554
1. **Open the Chat Interface**
@@ -116,7 +115,7 @@ This starts:
116115
## Cleanup
117116

118117
```bash
119-
docker-compose down
118+
./run_demo.sh down
120119
```
121120

122121
## Next Steps

demos/agent_orchestration/travel_agents/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This demo consists of two intelligent agents that work together seamlessly:
99
- **Weather Agent** - Real-time weather conditions and multi-day forecasts for any city worldwide
1010
- **Flight Agent** - Live flight information between airports with real-time tracking
1111

12-
All agents use Plano's agent orchestration LLM to intelligently route user requests to the appropriate specialized agent based on conversation context and user intent. Both agents run as Docker containers for easy deployment.
12+
All agents use Plano's agent orchestration LLM to intelligently route user requests to the appropriate specialized agent based on conversation context and user intent.
1313

1414
## Features
1515

@@ -22,8 +22,8 @@ All agents use Plano's agent orchestration LLM to intelligently route user reque
2222

2323
## Prerequisites
2424

25-
- Docker and Docker Compose
26-
- [Plano CLI](https://docs.planoai.dev/get_started/quickstart.html#prerequisites) installed
25+
- [Plano CLI](https://docs.planoai.dev/get_started/quickstart.html#prerequisites) installed (`pip install planoai`)
26+
- Docker and Docker Compose (for agent services)
2727
- [OpenAI API key](https://platform.openai.com/api-keys)
2828
- [FlightAware AeroAPI key](https://www.flightaware.com/aeroapi/portal)
2929

@@ -40,17 +40,18 @@ export AEROAPI_KEY="your-flightaware-api-key"
4040
export OPENAI_API_KEY="your OpenAI api key"
4141
```
4242

43-
### 2. Start All Agents & Plano with Docker
43+
### 2. Start the Demo
4444

4545
```bash
46-
docker compose up --build
46+
./run_demo.sh
4747
```
4848

49-
This starts:
49+
This starts Plano natively and brings up via Docker Compose:
5050
- Weather Agent on port 10510
5151
- Flight Agent on port 10520
5252
- Open WebUI on port 8080
53-
- Plano Proxy on port 8001
53+
54+
Plano runs natively on the host (port 8001).
5455

5556
### 4. Test the System
5657

@@ -92,7 +93,7 @@ Assistant: [Both weather_agent and flight_agent respond simultaneously]
9293
Weather Flight
9394
Agent Agent
9495
(10510) (10520)
95-
[Docker] [Docker]
96+
(10510) (10520)
9697
```
9798

9899
Each agent:
@@ -101,7 +102,7 @@ Each agent:
101102
3. Generates response using GPT-5.2
102103
4. Streams response back to user
103104

104-
Both agents run as Docker containers and communicate with Plano via `host.docker.internal`.
105+
Both agents run as Docker containers and communicate with Plano running natively on the host.
105106

106107
## Observability
107108

demos/filter_chains/http_filter/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ This demo consists of four components:
3535

3636
## Quick Start
3737

38-
### 1. Start everything with Docker Compose
38+
### 1. Start the demo
3939
```bash
40-
docker compose up --build
40+
export OPENAI_API_KEY="your-key"
41+
./run_demo.sh
4142
```
4243

43-
This brings up:
44+
This starts Plano natively and brings up via Docker Compose:
4445
- Input Guards MCP server on port 10500
4546
- Query Rewriter MCP server on port 10501
4647
- Context Builder MCP server on port 10502
4748
- RAG Agent REST server on port 10505
48-
- Plano listener on port 8001 (and gateway on 12000)
4949
- Jaeger UI for viewing traces at http://localhost:16686
5050
- AnythingLLM at http://localhost:3001 for interactive queries
5151

52-
> Set `OPENAI_API_KEY` in your environment before running; `LLM_GATEWAY_ENDPOINT` defaults to `http://host.docker.internal:12000/v1`.
52+
Plano runs natively on the host (port 8001 and 12000).
5353

5454
### 2. Test the system
5555

demos/filter_chains/mcp_filter/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ This demo consists of four components:
3535

3636
## Quick Start
3737

38-
### 1. Start everything with Docker Compose
38+
### 1. Start the demo
3939
```bash
40-
docker compose up --build
40+
export OPENAI_API_KEY="your-key"
41+
./run_demo.sh
4142
```
4243

43-
This brings up:
44+
This starts Plano natively and brings up via Docker Compose:
4445
- Input Guards MCP server on port 10500
4546
- Query Rewriter MCP server on port 10501
4647
- Context Builder MCP server on port 10502
4748
- RAG Agent REST server on port 10505
48-
- Plano listener on port 8001 (and gateway on 12000)
4949
- Jaeger UI for viewing traces at http://localhost:16686
5050
- AnythingLLM at http://localhost:3001 for interactive queries
5151

52-
> Set `OPENAI_API_KEY` in your environment before running; `LLM_GATEWAY_ENDPOINT` defaults to `http://host.docker.internal:12000/v1`.
52+
Plano runs natively on the host (port 8001 and 12000).
5353

5454
### 2. Test the system
5555

demos/llm_routing/claude_code_router/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Your Request → Plano → Suitable Model → Response
3939
# Install Claude Code if you haven't already
4040
npm install -g @anthropic-ai/claude-code
4141

42-
# Ensure Docker is running
43-
docker --version
42+
# Install Plano CLI
43+
pip install planoai
4444
```
4545

4646
### Step 1: Get Configuration

demos/llm_routing/openclaw_routing/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Plano uses a [preference-aligned router](https://arxiv.org/abs/2506.16655) to an
2323

2424
## Prerequisites
2525

26-
- **Docker** running
2726
- **Plano CLI**: `uv tool install planoai` or `pip install planoai`
2827
- **OpenClaw**: `npm install -g openclaw@latest`
2928
- **API keys**:
@@ -43,7 +42,7 @@ export ANTHROPIC_API_KEY="your-anthropic-key"
4342

4443
```bash
4544
cd demos/llm_routing/openclaw_routing
46-
planoai up --service plano --foreground
45+
planoai up config.yaml
4746
```
4847

4948
### 3. Set Up OpenClaw

demos/llm_routing/preference_based_routing/README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,23 @@ This demo shows how you can use user preferences to route user prompts to approp
33

44
## How to start the demo
55

6-
Make sure your machine is up to date with [latest version of plano]([url](https://github.com/katanemo/plano/tree/main?tab=readme-ov-file#prerequisites)). And you have activated the virtual environment.
6+
Make sure you have Plano CLI installed (`pip install planoai` or `uv tool install planoai`).
77

8+
```bash
9+
cd demos/llm_routing/preference_based_routing
10+
./run_demo.sh
11+
```
12+
13+
Or manually:
814

9-
1. start anythingllm
15+
1. Start Plano
1016
```bash
11-
(venv) $ cd demos/llm_routing/preference_based_routing
12-
(venv) $ docker compose up -d
17+
planoai up config.yaml
1318
```
14-
2. start plano in the foreground
19+
20+
2. Start AnythingLLM
1521
```bash
16-
(venv) $ planoai up --service plano --foreground
17-
# Or if installed with uv: uvx planoai up --service plano --foreground
18-
2025-05-30 18:00:09,953 - planoai.main - INFO - Starting plano cli version: 0.4.9
19-
2025-05-30 18:00:09,953 - planoai.main - INFO - Validating /Users/adilhafeez/src/intelligent-prompt-gateway/demos/llm_routing/preference_based_routing/config.yaml
20-
2025-05-30 18:00:10,422 - cli.core - INFO - Starting plano gateway, image name: plano, tag: katanemo/plano:0.4.9
21-
2025-05-30 18:00:10,662 - cli.core - INFO - plano status: running, health status: starting
22-
2025-05-30 18:00:11,712 - cli.core - INFO - plano status: running, health status: starting
23-
2025-05-30 18:00:12,761 - cli.core - INFO - plano is running and is healthy!
24-
...
22+
docker compose up -d
2523
```
2624

2725
3. open AnythingLLM http://localhost:3001/

0 commit comments

Comments
 (0)