Files
openwork/packages/docs/opencode-router.mdx
Omar McAdam 2b91b4d777 refactor: repo folder structure (#1038)
* refactor(repo): move OpenWork apps into apps and ee layout

Rebase the monorepo layout migration onto the latest dev changes so the moved app, desktop, share, and cloud surfaces keep working from their new paths. Carry the latest deeplink, token persistence, build, Vercel, and docs updates forward to avoid stale references and broken deploy tooling.

* chore(repo): drop generated desktop artifacts

Ignore the moved Tauri target and sidecar paths so local cargo checks do not pollute the branch. Remove the accidentally committed outputs from the repo while keeping the layout migration intact.

* fix(release): drop built server cli artifact

Stop tracking the locally built apps/server/cli binary so generated server outputs do not leak into commits. Also update the release workflow to check the published scoped package name for @openwork/server before deciding whether npm publish is needed.

* fix(workspace): add stable CLI bin wrappers

Point the server and router package bins at committed wrapper scripts so workspace installs can create shims before dist outputs exist. Keep the wrappers compatible with built binaries and source checkouts to avoid Vercel install warnings without changing runtime behavior.
2026-03-19 11:41:38 -07:00

48 lines
1.1 KiB
Plaintext

---
title: "OpenCode Router"
description: "What opencode-router is and when to use it"
---
`opencode-router` is a Slack + Telegram bridge and directory router for a running OpenCode/OpenWork instance.
## What it does
- Routes messages using `(channel, identity, peer) -> directory` bindings.
- Lets teams interact with workers from Slack or Telegram.
- Keeps chat surfaces mapped to the correct workspace.
- Handles text, files, images, and audio as first-class message parts.
## Quick start
```bash
npm install -g opencode-router
opencode-router
```
Or from monorepo:
```bash
pnpm -C apps/opencode-router setup
opencode-router start
```
## Required config
- `OPENCODE_URL`
- `OPENCODE_DIRECTORY`
## Common commands
```bash
opencode-router status
opencode-router telegram list
opencode-router slack list
opencode-router bindings list
opencode-router bindings set --channel telegram --identity default --peer <chatId> --dir /path/to/workdir
opencode-router send --channel slack --identity default --to D123 --file ./report.pdf
```
## In OpenWork UI
Open **Identities** to configure bot identities and directory bindings per worker.