@coreplane/switchboard 0.0.0 → 1.18.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1 +1,17 @@
-Placeholder. Real releases publish from GitHub Actions.
+# @coreplane/switchboard
+
+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.
+
+```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.
+
+```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
+```
+
+`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>.

package/dist/assets/.dockerignore

@@ -0,0 +1,27 @@
+node_modules
+dist
+data
+workspaces
+.env
+deploy
+# The Workers' manifests ARE needed: npm resolves the workspace tree from every
+# workspace's package.json, even when only root + web are installed.
+!deploy/cloudflare/package.json
+!deploy/cloudflare-memory/package.json
+!deploy/cloudflare-resident/package.json
+!deploy/cloudflare-sandbox/package.json
+!deploy/cloudflare-docs/package.json
+# `switchboard init` derives an installation's profile from the example; the container installs too.
+!deploy/profile.example.json
+# Which variables are credentials: src/secrets.ts reads the manifest at startup
+# (src/core/secretsManifest.test.ts holds this line and the Dockerfile's COPY in place).
+!deploy/secrets.manifest.json
+docs
+!docs/package.json
+README.md
+# .dockerignore patterns are root-anchored: `node_modules` above does NOT
+# cover web/'s tree. COPY web ./web runs after the image's own `npm ci` in
+# web/, so a host-installed (macOS) node_modules copied over it would break
+# the Linux image; web/dist is rebuilt in the image too.
+web/node_modules
+web/dist

package/dist/assets/.env.example

@@ -0,0 +1,33 @@
+# Slack (Socket Mode app)
+SLACK_BOT_TOKEN=xoxb-...
+SLACK_APP_TOKEN=xapp-...
+
+# Providers (referenced by apiKeyEnv in config.yaml)
+ANTHROPIC_API_KEY=sk-ant-...
+OPENAI_API_KEY=sk-...
+
+# Sandboxed execution (execution.type: e2b in config.yaml)
+E2B_API_KEY=e2b_...
+
+# Web search for the research agent (optional): without it, web_search answers that search is not configured.
+# BRAVE_SEARCH_API_KEY=BSA...
+
+# HTTP server (optional). Set PORT to expose the health probe, the authenticated
+# ingress/MCP channels (SWITCHBOARD_INGRESS_TOKENS — see docs/reference/specs/http-ingress.md),
+# and the live run-view page. PUBLIC_BASE_URL is the bot's public origin; when set,
+# each run's status card carries a live-view link (<PUBLIC_BASE_URL>/runs/<id>?t=<token>).
+# Unset -> live-view links are simply omitted; everything else still works.
+# PORT=8080
+# PUBLIC_BASE_URL=https://switchboard.example.com
+
+# GitHub identity for the coding/review agents — pick ONE:
+# (a) GitHub App (idiomatic: org-owned, no user, 1h tokens minted on demand).
+#     Org settings -> Developer settings -> GitHub Apps -> New GitHub App;
+#     permissions: Contents + Pull requests + Issues (read & write); webhook off; generate private key;
+#     install on selected repos (installation id is in the install page URL).
+#     Uncomment and fill in all three — a set variable counts as configured.
+# GITHUB_APP_ID=123456
+# GITHUB_APP_INSTALLATION_ID=12345678
+# GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
+# (b) Fallback: a fine-grained PAT scoped to only the repos the bot may touch.
+# GH_TOKEN=github_pat_...

package/dist/assets/Dockerfile

@@ -0,0 +1,111 @@
+# Switchboard — single-process Slack bot (Socket Mode, no inbound port needed).
+# git + gh are installed because the coding/review agents shell out to them.
+
+FROM node:24-slim AS build
+WORKDIR /app
+# One lockfile covers every workspace. npm needs each workspace's manifest on
+# disk to resolve the tree, so the manifests are copied before the install;
+# only the root and web dependencies are installed here (the Workers' toolchains
+# are never part of the image).
+COPY package.json package-lock.json ./
+COPY web/package.json ./web/
+COPY docs/package.json ./docs/
+COPY deploy/cloudflare/package.json ./deploy/cloudflare/
+COPY deploy/cloudflare-memory/package.json ./deploy/cloudflare-memory/
+COPY deploy/cloudflare-resident/package.json ./deploy/cloudflare-resident/
+COPY deploy/cloudflare-sandbox/package.json ./deploy/cloudflare-sandbox/
+COPY deploy/cloudflare-docs/package.json ./deploy/cloudflare-docs/
+COPY packages/switchboard/package.json ./packages/switchboard/
+RUN npm ci --include-workspace-root --workspace web
+COPY tsconfig.json tsconfig.build.json ./
+COPY src ./src
+COPY web ./web
+# The web app (Vue, served as hashed assets under /assets/*): vite build reads
+# the shared pure modules from ../src, so src must be in place first.
+RUN npm run build -w web
+RUN npm run build
+
+# Runtime dependencies alone: the bot's production dependencies, no dev tools,
+# no web toolchain — a clean install rather than a prune, so nothing hoisted
+# for the build survives into the image.
+FROM node:24-slim AS deps
+WORKDIR /app
+COPY package.json package-lock.json ./
+COPY web/package.json ./web/
+COPY docs/package.json ./docs/
+COPY deploy/cloudflare/package.json ./deploy/cloudflare/
+COPY deploy/cloudflare-memory/package.json ./deploy/cloudflare-memory/
+COPY deploy/cloudflare-resident/package.json ./deploy/cloudflare-resident/
+COPY deploy/cloudflare-sandbox/package.json ./deploy/cloudflare-sandbox/
+COPY deploy/cloudflare-docs/package.json ./deploy/cloudflare-docs/
+COPY packages/switchboard/package.json ./packages/switchboard/
+RUN npm ci --omit=dev --workspaces=false --include-workspace-root
+
+# meat (meat.dev): the abridged "reading diff" a PR review can carry
+# (docs/reference/specs/reading-diff.md). It runs HERE, on the bot host, over a
+# diff the bot fetches, with the bot's own Anthropic credential — never inside a
+# resident or sandbox, which is why neither execution image installs it. A
+# static Go binary (CGO off: bookworm-built, runs on this slim base without a
+# libc match) from a pinned commit of boldsoftware/meat: the project publishes
+# no release assets, and `@latest` would make the binary a property of the
+# build date — the pnpm lesson in src/deploy/imagePins.test.ts. Bumping the sha
+# is a reviewable commit; src/deploy/botImageMeat.test.ts holds this shape.
+FROM docker.io/library/golang:1.27.1-bookworm AS meat
+RUN CGO_ENABLED=0 go install meat.dev/cmd/meat@f39f41dfe7b5b37a12b35fdfbaecc7e779855bd3
+
+FROM node:24-slim
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends git curl ca-certificates \
+  && curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg \
+       -o /usr/share/keyrings/githubcli-archive-keyring.gpg \
+  && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" \
+       > /etc/apt/sources.list.d/github-cli.list \
+  && apt-get update && apt-get install -y --no-install-recommends gh \
+  && rm -rf /var/lib/apt/lists/*
+
+# The one binary the meat stage built; `meat -h` exits 0 and proves the static
+# binary runs on this base (`command -v` is the probe the host runner uses).
+COPY --from=meat /go/bin/meat /usr/local/bin/meat
+RUN command -v meat >/dev/null && meat -h >/dev/null 2>&1
+
+# Non-root user; agents run bash with this user's (container-scoped) permissions.
+RUN useradd -m -u 1001 switchboard
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY --from=build /app/dist ./dist
+# The built web app: index.ts loads /app/web/dist at startup (manifest + assets).
+COPY --from=build /app/web/dist ./web/dist
+# build.json is written by deploy/cloudflare/write-build.mjs (npm run deploy) and
+# served on /healthz as `build`; the glob keeps it optional so a bare
+# `wrangler deploy` / docker compose still builds (the bot then says "unknown").
+COPY package.json project.json build.jso[n] ./
+# No config in the image: SWITCHBOARD_CONFIG names a file mounted at run time
+# (docker compose: ./config → /app/config) or `state://base`, the document
+# `deploy config` pushed to the state Worker (what the Cloudflare shim sets).
+# The EXAMPLES are not config: `switchboard init` derives an installation's
+# `.env` and `config.yaml` from them, so the container can install too.
+COPY .env.example ./
+COPY config/config.example.yaml ./config/
+COPY deploy/profile.example.json ./deploy/
+# Which environment variables are credentials: src/secrets.ts reads the manifest at
+# startup (src/core/secretsManifest.test.ts holds this line in place).
+COPY deploy/secrets.manifest.json ./deploy/
+# Bundled skills (#100): loaded at startup by BundledSkillStore from /app/skills.
+COPY skills ./skills
+RUN mkdir -p /app/data /app/workspaces && chown -R switchboard:switchboard /app
+USER switchboard
+
+# gh auth: set GH_TOKEN (fine-grained PAT for a machine account); gh and git
+# (via gh's credential helper, configured below) pick it up automatically.
+RUN git config --global credential.helper '!gh auth git-credential' \
+  && git config --global user.name "switchboard-bot" \
+  && git config --global user.email "switchboard-bot@users.noreply.github.com"
+
+ENV NODE_ENV=production
+# PORT enables the /healthz-style probe endpoint (any path returns 200).
+ENV PORT=8080
+EXPOSE 8080
+# One image, two jobs: no arguments runs the bot (compose, Cloudflare); arguments
+# run the CLI (`init`, `ask`, `<group> <verb>`) — see docker-entrypoint.sh.
+COPY --chmod=755 docker-entrypoint.sh /usr/local/bin/switchboard
+ENTRYPOINT ["switchboard"]