This commit is contained in:
adilhafeez 2026-03-05 15:35:59 +00:00
parent bcc5de0bca
commit c4dec527a9
34 changed files with 180 additions and 86 deletions

View file

@ -1,6 +1,6 @@
Plano Docs v0.4.9
llms.txt (auto-generated)
Generated (UTC): 2026-03-01T12:06:12.796693+00:00
Generated (UTC): 2026-03-05T15:35:55.552925+00:00
Table of contents
- Agents (concepts/agents)
@ -172,16 +172,16 @@ version: v0.3.0
agents:
- id: rag_agent
url: http://host.docker.internal:10505
url: http://localhost:10505
filters:
- id: query_rewriter
url: http://host.docker.internal:10501
url: http://localhost:10501
# type: mcp # default is mcp
# transport: streamable-http # default is streamable-http
# tool: query_rewriter # default name is the filter id
- id: context_builder
url: http://host.docker.internal:10502
url: http://localhost:10502
model_providers:
- model: openai/gpt-4o-mini
@ -932,7 +932,7 @@ llm_providers:
access_key: $ANTHROPIC_API_KEY
- model: ollama/llama3.1
base_url: http://host.docker.internal:11434
base_url: http://localhost:11434
# Define aliases that map to the models above
model_aliases:
@ -1842,9 +1842,9 @@ llm_providers:
- model: ollama/llama3.1
base_url: http://localhost:11434
# Ollama in Docker (from host)
# Ollama running locally
- model: ollama/codellama
base_url: http://host.docker.internal:11434
base_url: http://localhost:11434
OpenAI-Compatible Providers
@ -3075,14 +3075,20 @@ The full agent and backend API implementations used here are available in the pl
Prerequisites
Before you begin, ensure you have the following:
Plano runs natively by default — no Docker or Rust toolchain required. Pre-compiled binaries are downloaded automatically on first run.
Python (v3.10+)
Supported platforms: Linux (x86_64, aarch64), macOS (Apple Silicon)
Docker mode (optional):
If you prefer to run inside Docker, add --docker to planoai up / planoai down. This requires:
Docker System (v24)
Docker Compose (v2.29)
Python (v3.10+)
Planos CLI allows you to manage and interact with the Plano efficiently. To install the CLI, simply run the following command:
We recommend using uv for fast, reliable Python package management. Install uv if you havent already:
@ -3130,15 +3136,16 @@ Step 2. Start plano
Once the config file is created, ensure that you have environment variables set up for ANTHROPIC_API_KEY and OPENAI_API_KEY (or these are defined in a .env file).
Start Plano:
$ planoai up plano_config.yaml
# Or if installed with uv tool: uvx planoai up plano_config.yaml
2024-12-05 11:24:51,288 - planoai.main - INFO - Starting plano cli version: 0.4.9
2024-12-05 11:24:51,825 - planoai.utils - INFO - Schema validation successful!
2024-12-05 11:24:51,825 - planoai.main - INFO - Starting plano
...
2024-12-05 11:25:16,131 - planoai.core - INFO - Container is healthy!
On the first run, Plano automatically downloads Envoy, WASM plugins, and brightstaff and caches them at ~/.plano/.
To stop Plano, run planoai down.
Docker mode (optional):
$ planoai up plano_config.yaml --docker
$ planoai down --docker
Step 3: Interact with LLM
@ -3218,9 +3225,9 @@ version: v0.1.0
agents:
- id: flight_agent
url: http://host.docker.internal:10520 # your flights service
url: http://localhost:10520 # your flights service
- id: hotel_agent
url: http://host.docker.internal:10530 # your hotels service
url: http://localhost:10530 # your hotels service
model_providers:
- model: openai/gpt-4o
@ -3960,7 +3967,7 @@ scrape_configs:
scheme: http
static_configs:
- targets:
- host.docker.internal:19901
- localhost:19901
params:
format: ["prometheus"]
@ -4610,9 +4617,9 @@ version: v0.3.0
agents:
- id: weather_agent
url: http://host.docker.internal:10510
url: http://localhost:10510
- id: flight_agent
url: http://host.docker.internal:10520
url: http://localhost:10520
model_providers:
- model: openai/gpt-4o
@ -6056,15 +6063,15 @@ version: v0.3.0
# External HTTP agents - API type is controlled by request path (/v1/responses, /v1/messages, /v1/chat/completions)
agents:
- id: weather_agent # Example agent for weather
url: http://host.docker.internal:10510
url: http://localhost:10510
- id: flight_agent # Example agent for flights
url: http://host.docker.internal:10520
url: http://localhost:10520
# MCP filters applied to requests/responses (e.g., input validation, query rewriting)
filters:
- id: input_guards # Example filter for input validation
url: http://host.docker.internal:10500
url: http://localhost:10500
# type: mcp (default)
# transport: streamable-http (default)
# tool: input_guards (default - same as filter id)
@ -6167,7 +6174,39 @@ Doc: resources/deployment
Deployment
This guide shows how to deploy Plano directly using Docker without the plano CLI, including basic runtime checks for routing and health monitoring.
Plano can be deployed in two ways: natively on the host (default) or inside a Docker container.
Native Deployment (Default)
Plano runs natively by default. Pre-compiled binaries (Envoy, WASM plugins, brightstaff) are automatically downloaded on the first run and cached at ~/.plano/.
Supported platforms: Linux (x86_64, aarch64), macOS (Apple Silicon).
Start Plano
planoai up plano_config.yaml
Options:
--foreground — stay attached and stream logs (Ctrl+C to stop)
--with-tracing — start a local OTLP trace collector
Runtime files (rendered configs, logs, PID file) are stored in ~/.plano/run/.
Stop Plano
planoai down
Build from Source (Developer)
If you want to build from source instead of using pre-compiled binaries, you need:
Rust with the wasm32-wasip1 target
OpenSSL dev headers (libssl-dev on Debian/Ubuntu, openssl on macOS)
planoai build --native
Docker Deployment
@ -6207,6 +6246,11 @@ Check container health and logs:
docker compose ps
docker compose logs -f plano
You can also use the CLI with Docker mode:
planoai up plano_config.yaml --docker
planoai down --docker
Runtime Tests
Perform basic runtime tests to verify routing and functionality.