diff --git a/README.md b/README.md index 99fe3154..bd0cc90a 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ CodeNomad transforms OpenCode from a terminal tool into a **premium desktop work - **🎙️ Voice Input & Speech** - **🌳 Git Worktrees** - **💬 Rich Message Experience** +- **🧩 SideCars** - **⌨️ Command Palette** - **📁 File System Browser** - **🔐 Authentication & Security** @@ -61,6 +62,60 @@ npx @neuralnomads/codenomad-dev --launch --- +## SideCars + +SideCars let you open local web tools inside CodeNomad as tabs. + +
+Configuration + +- **Name**: Display name used in CodeNomad +- **Port**: Local HTTP or HTTPS service running on `127.0.0.1:` +- **Base path**: Mounted under `/sidecars/:id` +- **Prefix mode**: + - **Preserve prefix** forwards the full `/sidecars/:id/...` path upstream + - **Strip prefix** removes `/sidecars/:id` before forwarding the request upstream + +
+ +
+VSCode (OpenVSCode Server) + +Run with Docker: + +```bash +docker run -it --init -p 8000:3000 -v "${HOME}:${HOME}:cached" -e HOME=${HOME} gitpod/openvscode-server --server-base-path /sidecars/vscode +``` + +Add SideCar as: + +- **Name**: `VSCode` +- **Port**: `http://127.0.0.1:8000` +- **Base path**: `/sidecars/vscode` +- **Prefix mode**: `Preserve prefix` + +
+ +
+Terminal (ttyd) + +Run with: + +```bash +ttyd --writable zsh +``` + +Add SideCar as: + +- **Name**: `Terminal` +- **Port**: `http://127.0.0.1:7681` +- **Base path**: `/sidecars/terminal` +- **Prefix mode**: `Strip prefix` + +
+ +--- + ## Requirements - **[OpenCode CLI](https://opencode.ai)** — must be installed and in your `PATH`