@coreplane/switchboard 1.18.1 → 1.18.2

package/README.md

@@ -1,17 +1,54 @@
-# @coreplane/switchboard
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/logo-dark.svg">
+  <img src="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/logo-light.svg" width="56" height="56" alt="">
+</picture>
 
-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.
+# OpenSwitchboard
+
+[![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)
+
+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.
+
+<p align="center">
+  <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">
+</p>
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/coreplanelabs/switchboard/HEAD/docs/public/screenshots/run-page-dark.png">
+  <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%">
+</picture>
+
+## Quick start
+
+Node 24 and an Anthropic API key; no Slack.
 
 ```bash
 npx @coreplane/switchboard init --organization <your GitHub org> --anthropic-key <your key>
 npx @coreplane/switchboard ask "what can you do?"
 ```
 
-`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.
+`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`.
 
-```bash
-npx @coreplane/switchboard init --force --organization <your GitHub org> --anthropic-key <your key> --slack-app-token <xapp-…> --slack-bot-token <xoxb-…>
-npx @coreplane/switchboard start
-```
+Next: [Get started](https://github.com/coreplanelabs/switchboard/blob/HEAD/docs/tutorials/get-started.md).
+
+## How it is put together
+
+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)).
+
+
+## What you need
+
+| | You need | What it unlocks |
+|---|---|---|
+| **Required** | A model provider key: Anthropic, or any OpenAI-compatible endpoint | Every agent |
+| **For Slack** | A Slack app (Socket Mode: bot token + app-level token) | The bot in your workspace |
+| Optional | A GitHub App, or a repo-scoped token | Repository reads; pull requests |
+| Optional | A Cloudflare account | Production: the bot plus the state, resident and sandbox Workers |
+| Optional | An E2B account | Per-thread micro-VMs without Cloudflare |
+| Optional | A Brave Search key (`BRAVE_SEARCH_API_KEY`) | Web search for the research agent |
+
+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`.
+
+## Learn more
 
-`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>.
+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).

package/dist/assets/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "switchboard",
-  "version": "1.18.1",
+  "version": "1.18.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "switchboard",
-      "version": "1.18.1",
+      "version": "1.18.2",
       "license": "Apache-2.0",
       "workspaces": [
         "web",
@@ -18340,7 +18340,7 @@
     },
     "packages/switchboard": {
       "name": "@coreplane/switchboard",
-      "version": "1.18.1",
+      "version": "1.18.2",
       "license": "Apache-2.0",
       "dependencies": {
         "@anthropic-ai/sdk": "^0.124.0",

package/dist/assets/package.json

@@ -1,6 +1,6 @@
 {
   "name": "switchboard",
-  "version": "1.18.1",
+  "version": "1.18.2",
   "private": true,
   "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.",
   "license": "Apache-2.0",

package/dist/assets/source.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.18.1",
-  "commit": "b1f3963f3c2bff6d26bc6803ccf928f7f435b07b",
-  "builtAt": "2026-09-10T20:53:16.987Z"
+  "version": "1.18.2",
+  "commit": "c8e72294e24f57e162650586aa5a4f68057fee04",
+  "builtAt": "2026-09-10T21:20:58.687Z"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coreplane/switchboard",
-  "version": "1.18.1",
+  "version": "1.18.2",
   "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.",
   "license": "Apache-2.0",
   "homepage": "https://openswitchboard.dev",