Skip to content

Commit 38d4909

Browse files
committed
updated documentation and added an example model to use
1 parent 9926b9c commit 38d4909

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,6 @@ uv sync --extra full
5353
Each service runs on its own port:
5454

5555
```bash
56-
# uv run --no-sync python -m uvicorn opencad_kernel.api:app --reload --port 8000 # 1 – Kernel
57-
# uv run --no-sync python -m uvicorn opencad_solver.api:app --reload --port 8001 # 2 – Solver
58-
# uv run --no-sync python -m uvicorn opencad_tree.api:app --reload --port 8002 # 3 – Tree
59-
# uv run --no-sync python -m uvicorn opencad_agent.api:app --reload --port 8003 # 5 – Agent
60-
6156
cd backend
6257
uv run --no-sync python -m uvicorn api:app --reload --port 8000
6358
```
@@ -89,10 +84,10 @@ BACKEND_HOST=0.0.0.0 BACKEND_PORT=8000 FRONTEND_HOST=0.0.0.0 FRONTEND_PORT=5173
8984
### 3. Check health
9085

9186
```bash
92-
curl -s http://127.0.0.1:8000/healthz # → {"status":"ok"}
93-
curl -s http://127.0.0.1:8001/healthz
94-
curl -s http://127.0.0.1:8002/healthz
95-
curl -s http://127.0.0.1:8003/healthz
87+
curl -s http://127.0.0.1:8000/kernel/healthz # → {"status":"ok"}
88+
curl -s http://127.0.0.1:8000/agent/healthz
89+
curl -s http://127.0.0.1:8000/solver/healthz
90+
curl -s http://127.0.0.1:8000/tree/healthz
9691
```
9792

9893
### 4. Start the frontend

backend/.env.example

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ OPENCAD_TREE_LIVE_KERNEL=true
2222
OPENCAD_AGENT_LIVE_KERNEL=true
2323

2424
OPENCAD_LLM_PROVIDER=
25-
OPENCAD_LLM_MODEL=
25+
OPENCAD_LLM_MODEL=claude-sonnet-4-5-20250929
26+
# use can use any model compatible with litellm
2627

2728
# Optional multi-provider LLM support for code generation uses LiteLLM.
2829
# Provider-specific credentials are still read from each provider's standard env vars.

0 commit comments

Comments
 (0)