Skip to content

Open-source AI teammates in Slack, Teams, Discord, Telegram and Mattermost. Self-host it, with any agent harness and any model.

Revert bad merge (#296)

Louis Amaudruzdf06ab6b5fd2
diff --git a/README.md b/README.md
index 3a0438cf6..1fbb196e3 100644
--- a/README.md
+++ b/README.md
@@ -194,128 +194,6 @@ dashboard covers the rest.
one up for you, on this machine or on a host you own, without you writing any
Compose or Helm configuration.
-1. In the gateway, create a room (and note its id).
-2. Install and configure the connector so your agent registers as a Switch
- agent and joins the room. For Claude Code, the plugin's `configure` skill
- walks you through registering with this Switch instance and writing the
- credentials. The Codex plugin ships the room-workflow skill only — its
- Switch MCP server is registered by the [Switch Console desktop app](console/) when
- it launches the session, so set the agent up there; see
- [`connectors/codex-plugin/README.md`](connectors/codex-plugin/README.md).
-3. Talk to the agent from Mattermost, and watch the interaction in the gateway.
-
-Stop the stack with `just standalone-down`, or `just standalone-reset` to also
-wipe the data volumes.
-
-> ⚠️ **`just standalone-reset` is destructive.** It deletes the data volumes —
-> every room, message, agent, user, and resource you created is gone for good.
-> Use `just standalone-down` for an ordinary stop that keeps your data.
-
-## Getting started (local development)
-
-**Prerequisites:** [Docker](https://docs.docker.com/get-docker/),
-[uv](https://docs.astral.sh/uv/), and [just](https://github.com/casey/just)
-(`brew install just`).
-
-```bash
-just init-env # first-time setup — generate .env with random secrets
-uv sync # install Python dependencies
-just gateway-install # install gateway frontend deps (first time only)
-just up # start the supporting stack (Docker Compose)
-just run # run switch-core locally (:8000)
-just gateway-dev # run the gateway frontend (separate terminal)
-```
-
-`just up` starts the **supporting services** in Docker — Tuwunel, PostgreSQL,
-and Mattermost. You run **switch-core** and the **gateway**
-yourself, locally, so you get hot-reload while developing: `just run`
-(switch-core on `:8000`) and `just gateway-dev` (the frontend), each in its own
-terminal. Stop the stack with `just down` (or `just reset` to also wipe
-volumes).
-
-## Common commands
-
-Run `just` with no arguments to list every recipe. The most-used ones:
-
-| Command | What it does |
-|---|---|
-| `just init-env` | Generate `.env` with freshly generated secrets (no default login) |
-| `just up` / `just down` | Start / stop the local dev stack |
-| `just reset` | Stop the stack and wipe volumes (incl. the Tuwunel database) |
-| `just standalone-up` / `just standalone-down` | Start / stop the full standalone stack (no dev tooling) |
-| `just standalone-reset` | Stop the standalone stack and wipe its volumes |
-| `just run` | Run switch-core locally (`python -m switch_core.main`) |
-| `just migrate` | Apply migrations (`alembic upgrade head`) |
-| `just migration "msg"` | Autogenerate a new Alembic migration |
-| `just format` | Format + autofix with ruff |
-| `just check` | Lint/format check (CI mode, no changes) |
-| `just typecheck` | Type-check with mypy |
-| `just test` | Run the test suite (`pytest core/tests/`); `just test -k name` for one test |
-| `just gateway-dev` / `just gateway-build` | Run / build the gateway frontend |
-
-## Architecture
-
-The platform service lives in [`core/switch_core/`](core/switch_core/)
-(import root `switch_core`, distribution name `switch-core`). It is async
-throughout — all I/O (Matrix, DB, external APIs) is async — and every room
-participant is a Matrix client (matrix-nio) connecting to Tuwunel. Persistence
-is PostgreSQL, managed with Alembic.
-
-Module layout under `core/switch_core/`:
-
-| Module | Responsibility |
-|---|---|
-| `config.py` | Pydantic `BaseSettings` — all config from environment variables |
-| `db/` | SQLAlchemy models, async engine/session, and query stores |
-| `migrations/` | Alembic migrations (`env.py`, `versions/`) |
-| `rooms/` | Room lifecycle, configuration, provisioning |
-| `clients/` | Matrix clients (agent, user, resource manager, observe) |
-| `bridges/` | External integrations — `agent/`, `collaboration/`, `observe/`, `resource/` |
-| `protect/` | Protection pipeline (checks, protect bridge, API) |
-| `gateway/` | Management API for the frontend |
-
-The operator dashboard frontend lives in [`gateway/`](gateway/)
-(Node/Vite, served via nginx).
-
-## Documentation
-
-User-facing documentation is published at
-**[docs.flintai.dev](https://docs.flintai.dev/flintai/switch/getting-started)** —
-installing Switch Console, adding a server, onboarding agents, creating rooms,
-[connecting a messaging app](https://docs.flintai.dev/flintai/switch/deploy/messaging-apps)
-and [hosting remotely](https://docs.flintai.dev/flintai/switch/deploy/host-remotely).
-
-Design and protocol references for contributors live in [`docs/`](docs/):
-[`ARCHITECTURE.md`](docs/ARCHITECTURE.md) for the system overview and
-[`api/AGENT_PROTOCOL.md`](docs/api/AGENT_PROTOCOL.md) for the agent protocol.
-
-## Repository layout
-
-| Path | Contents |
-|---|---|
-| `core/` | Backend tree — a self-contained Python project (`pyproject.toml`, `uv.lock`, `alembic.ini`) holding the service package and tests |
-| `core/switch_core/` | The main Python service package (import root `switch_core`, dist `switch-core`) |
-| `core/tests/` | Test suite, mirroring the `switch_core/` module structure |
-| `gateway/` | Operator dashboard frontend (Node/Vite) |
-| `console/` | The Switch Console desktop app |
-| `connectors/` | Agent connectors (`claude-code-plugin`, `codex-plugin`) |
-| `deploy/` | Deployment assets — Docker Compose stacks (`local/`), the Kubernetes Helm chart (`remote/helm/switch/`, see its [README](deploy/remote/helm/switch/README.md)) and shared resources |
-| `justfile` | Repo-root task runner (drives all three code trees) |
-
-## Testing
-
-Tests live in `core/tests/switch_core/` and mirror the module structure. The
-suite uses pytest with pytest-asyncio; store tests run against a real
-PostgreSQL instance (not mocks, not SQLite). Run them with `just test`.
-
-## License
-
-Agent Switch is licensed under the **Apache License 2.0 with the Commons Clause**
-condition (Copyright (c) 2026 SB Technology, Inc. dba SandboxAQ) — see
-[`LICENSE`](LICENSE) for the full text. The Commons Clause removes the right to
-_Sell_ the software (including paid hosting or support offerings whose value
-derives substantially from it); all other Apache 2.0 grants are unchanged.
-
## Contributing
Switch is being built in the open, with the people who use it. Nobody knows yet