@coreplane/switchboard 1.18.1 → 1.19.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,54 @@
1
- # @coreplane/switchboard
1
+ <picture>
2
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/logo-dark.svg">
3
+ <img src="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/logo-light.svg" width="56" height="56" alt="">
4
+ </picture>
2
5
 
3
- The OpenSwitchboard command line — and the bot itself: the installer, the operator commands and `start` of [Switchboard](https://github.com/coreplanelabs/switchboard), an agent gateway — mention it in Slack and an agent reviews the PR, ships the fix, or answers the question, on the model you choose, with its tools running where you decide.
6
+ # OpenSwitchboard
7
+
8
+ [![CI](https://github.com/coreplanelabs/switchboard/actions/workflows/ci.yml/badge.svg)](https://github.com/coreplanelabs/switchboard/actions/workflows/ci.yml) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/coreplanelabs/switchboard/badge)](https://scorecard.dev/viewer/?uri=github.com/coreplanelabs/switchboard) [![Latest release](https://img.shields.io/github/v/release/coreplanelabs/switchboard)](https://github.com/coreplanelabs/switchboard/releases/latest) [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/coreplanelabs/switchboard/blob/HEAD/LICENSE)
9
+
10
+ Mention it in Slack and an agent reviews the PR, ships the fix, or answers the question — on the model you choose, with its tools running where you decide.
11
+
12
+ <p align="center">
13
+ <img alt="A review in a Slack thread: the mention, the status card ticking through the run's steps, then the verdict with its findings." src="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/slack/run.gif" width="395">
14
+ </p>
15
+
16
+ <picture>
17
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/screenshots/run-page-dark.png">
18
+ <img alt="A finished run's page on the dashboard." src="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/screenshots/run-page-light.png" width="100%">
19
+ </picture>
20
+
21
+ ## Quick start
22
+
23
+ Node 24 and an Anthropic API key; no Slack.
4
24
 
5
25
  ```bash
6
26
  npx @coreplane/switchboard init --organization <your GitHub org> --anthropic-key <your key>
7
27
  npx @coreplane/switchboard ask "what can you do?"
8
28
  ```
9
29
 
10
- `init` writes `.env` (mode 600) and `config/config.yaml` into `~/.switchboard` from the examples this package ships, so every command works from any directory (`SWITCHBOARD_HOME` puts the installation elsewhere); `ask` runs the whole pipeline with your terminal as the channel. `switchboard help` lists every command; `switchboard <group> <verb> --help` explains one.
30
+ `init` writes `.env` (mode 600) and `config/config.yaml` into `~/.switchboard`, so every command works from any directory; `ask` runs the whole pipeline. `curl -fsSL https://openswitchboard.dev/install.sh | sh` is the same `init`.
11
31
 
12
- ```bash
13
- npx @coreplane/switchboard init --force --organization <your GitHub org> --anthropic-key <your key> --slack-app-token <xapp-…> --slack-bot-token <xoxb-…>
14
- npx @coreplane/switchboard start
15
- ```
32
+ Next: [Get started](https://github.com/coreplanelabs/switchboard/blob/HEAD/docs/tutorials/get-started.md).
33
+
34
+ ## How it is put together
35
+
36
+ Four seams: Channel, Provider, Executor, Agent. Each is an interface with more than one implementation. The dispatcher sits between them: directives, config layers, authorization, the agent loop ([How a request flows](https://github.com/coreplanelabs/switchboard/blob/HEAD/docs/explanation/how-a-request-flows.md)).
37
+
38
+
39
+ ## What you need
40
+
41
+ | | You need | What it unlocks |
42
+ |---|---|---|
43
+ | **Required** | A model provider key: Anthropic, or any OpenAI-compatible endpoint | Every agent |
44
+ | **For Slack** | A Slack app (Socket Mode: bot token + app-level token) | The bot in your workspace |
45
+ | Optional | A GitHub App, or a repo-scoped token | Repository reads; pull requests |
46
+ | Optional | A Cloudflare account | Production: the bot plus the state, resident and sandbox Workers |
47
+ | Optional | An E2B account | Per-thread micro-VMs without Cloudflare |
48
+ | Optional | A Brave Search key (`BRAVE_SEARCH_API_KEY`) | Web search for the research agent |
49
+
50
+ Off means absent from `help`, the dashboard and the plan ([Turn features on and off](https://github.com/coreplanelabs/switchboard/blob/HEAD/docs/how-to/turn-features-on-and-off.md)). The bot is `npx @coreplane/switchboard start` on any machine with Node, or the published image `ghcr.io/coreplanelabs/switchboard`.
51
+
52
+ ## Learn more
16
53
 
17
- `start` runs the bot — the same process the published container image runs — from the installation `init` wrote, over Slack's Socket Mode, until Ctrl-C: no Docker, no public address. `start --help` says what it reads. The same bot as a container is `ghcr.io/coreplanelabs/switchboard`. The deploy commands (`init --cloudflare`, `deploy plan|init|secrets|config|images|all`) run from anywhere against that installation, no checkout needed: the profile `init` writes says `"images": "registry"`, so every Worker, the bot included, runs the image the release published, and `deploy all` copies it once per version into your Cloudflare account's registry itself — over HTTPS, with a Cloudflare API token that has Containers Edit; nothing is built where you deploy and no Docker is involved ([Deploy](https://openswitchboard.dev/how-to/deploy#deploying-from-the-package)). If you want the same command in CI, call the repository's reusable deploy workflow from a workflow of your own — `uses: <owner>/<repo>/.github/workflows/deploy-production.yml@v<version>` with `cli: package` ([Deploy from your CI](https://openswitchboard.dev/how-to/deploy#deploy-from-your-ci)). Everything else: <https://openswitchboard.dev>.
54
+ Docs: <https://openswitchboard.dev> ([`docs/`](https://github.com/coreplanelabs/switchboard/blob/HEAD/docs/README.md)) · [CONTRIBUTING.md](https://github.com/coreplanelabs/switchboard/blob/HEAD/CONTRIBUTING.md) · [AGENTS.md](https://github.com/coreplanelabs/switchboard/blob/HEAD/AGENTS.md) · [SECURITY.md](https://github.com/coreplanelabs/switchboard/blob/HEAD/SECURITY.md) · [Apache-2.0](https://github.com/coreplanelabs/switchboard/blob/HEAD/LICENSE).
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "switchboard",
3
- "version": "1.18.1",
3
+ "version": "1.19.2",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "switchboard",
9
- "version": "1.18.1",
9
+ "version": "1.19.2",
10
10
  "license": "Apache-2.0",
11
11
  "workspaces": [
12
12
  "web",
@@ -18340,7 +18340,7 @@
18340
18340
  },
18341
18341
  "packages/switchboard": {
18342
18342
  "name": "@coreplane/switchboard",
18343
- "version": "1.18.1",
18343
+ "version": "1.19.2",
18344
18344
  "license": "Apache-2.0",
18345
18345
  "dependencies": {
18346
18346
  "@anthropic-ai/sdk": "^0.124.0",
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "switchboard",
3
- "version": "1.18.1",
3
+ "version": "1.19.2",
4
4
  "private": true,
5
5
  "description": "Mention it in Slack and an agent reviews the PR, ships the fix, or answers the question — on the model you choose, with its tools running where you decide.",
6
6
  "license": "Apache-2.0",
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.18.1",
3
- "commit": "b1f3963f3c2bff6d26bc6803ccf928f7f435b07b",
4
- "builtAt": "2026-09-10T20:53:16.987Z"
2
+ "version": "1.19.2",
3
+ "commit": "7f323b1a2a517f0fad2cb942dfd8cd29ab12f458",
4
+ "builtAt": "2026-09-10T23:17:28.992Z"
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coreplane/switchboard",
3
- "version": "1.18.1",
3
+ "version": "1.19.2",
4
4
  "description": "Mention it in Slack and an agent reviews the PR, ships the fix, or answers the question — on the model you choose, with its tools running where you decide.",
5
5
  "license": "Apache-2.0",
6
6
  "homepage": "https://openswitchboard.dev",