summaryrefslogtreecommitdiffhomepage
path: root/packages/sdk/python/docs/generation.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/sdk/python/docs/generation.md')
-rw-r--r--packages/sdk/python/docs/generation.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/packages/sdk/python/docs/generation.md b/packages/sdk/python/docs/generation.md
index f949760a1..2151e3709 100644
--- a/packages/sdk/python/docs/generation.md
+++ b/packages/sdk/python/docs/generation.md
@@ -3,10 +3,12 @@
The SDK is generated from the Opencode server's OpenAPI 3.1 spec.
Two source modes are supported:
+
- CLI (default): runs `bun dev generate` to emit the OpenAPI JSON
- Server: fetches `http://localhost:4096/doc` from a running server
Generator command
+
```bash
# From repo root
uv run --project packages/sdk/python python packages/sdk/python/scripts/generate.py --source cli
@@ -15,5 +17,6 @@ uv run --project packages/sdk/python python packages/sdk/python/scripts/generate
```
Post-generation
+
- The generator injects `extras.py` (OpenCodeClient) and patches `__init__.py` to export it
- Code is formatted with `ruff` (imports) and `black`