summaryrefslogtreecommitdiffhomepage
path: root/packages/sdk/python/docs/installation.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/sdk/python/docs/installation.md')
-rw-r--r--packages/sdk/python/docs/installation.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/packages/sdk/python/docs/installation.md b/packages/sdk/python/docs/installation.md
new file mode 100644
index 000000000..f66e217ae
--- /dev/null
+++ b/packages/sdk/python/docs/installation.md
@@ -0,0 +1,27 @@
+# Installation
+
+Requirements
+- Python 3.8+
+- uv (recommended) -> https://docs.astral.sh/uv/
+
+Install uv
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Project setup
+```bash
+# From repo root or this directory
+uv sync --dev --project packages/sdk/python
+```
+
+Using pip (alternative)
+```bash
+pip install opencode-ai
+```
+
+Preview docs locally
+```bash
+# From repo root
+uv run --project packages/sdk/python mkdocs serve -f packages/sdk/python/mkdocs.yml
+```