{"id":35324357,"url":"https://github.com/sidebandtech/sideband","last_synced_at":"2026-03-08T00:10:22.816Z","repository":{"id":325769196,"uuid":"1102167780","full_name":"sidebandtech/sideband","owner":"sidebandtech","description":"Browser ↔ local daemon communication SDK for TypeScript, without WebSocket plumbing.","archived":false,"fork":false,"pushed_at":"2026-03-05T22:12:39.000Z","size":4982,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-06T02:41:48.491Z","etag":null,"topics":["agent","browser","bun","bunjs","daemon","e2ee","local-first","multiplexing","nat-traversal","networking","p2p","rpc","sdk","secure-communication","transport","typescript","web-ui","websockets"],"latest_commit_sha":null,"homepage":"https://sideband.tech","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sidebandtech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":["koistya"]}},"created_at":"2025-11-23T00:03:35.000Z","updated_at":"2026-03-05T22:11:39.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sidebandtech/sideband","commit_stats":null,"previous_names":["sidebandtech/sideband"],"tags_count":58,"template":false,"template_full_name":null,"purl":"pkg:github/sidebandtech/sideband","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidebandtech%2Fsideband","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidebandtech%2Fsideband/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidebandtech%2Fsideband/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidebandtech%2Fsideband/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sidebandtech","download_url":"https://codeload.github.com/sidebandtech/sideband/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidebandtech%2Fsideband/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30231466,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T19:01:10.287Z","status":"ssl_error","status_checked_at":"2026-03-07T18:59:58.103Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","browser","bun","bunjs","daemon","e2ee","local-first","multiplexing","nat-traversal","networking","p2p","rpc","sdk","secure-communication","transport","typescript","web-ui","websockets"],"created_at":"2025-12-31T01:04:02.671Z","updated_at":"2026-03-08T00:10:22.811Z","avatar_url":"https://github.com/sidebandtech.png","language":"TypeScript","funding_links":["https://github.com/sponsors/koistya"],"categories":[],"sub_categories":[],"readme":"# Sideband\n\n[![CI](https://github.com/sidebandtech/sideband/actions/workflows/ci.yml/badge.svg)](https://github.com/sidebandtech/sideband/actions)\n[![npm peer](https://img.shields.io/npm/v/@sideband/peer.svg?label=%40sideband%2Fpeer)](https://www.npmjs.com/package/@sideband/peer)\n[![npm cloud](https://img.shields.io/npm/v/@sideband/cloud.svg?label=%40sideband%2Fcloud)](https://www.npmjs.com/package/@sideband/cloud)\n[![npm sideband](https://img.shields.io/npm/v/sideband.svg?label=sideband)](https://www.npmjs.com/package/sideband)\n\nBrowser ↔ daemon/agent communication — direct or E2EE cloud-relayed, with typed RPC and events.\n\n\u003e **Early-stage.** APIs may evolve. If you're building on this, [reach out](mailto:hello@sideband.tech) — feedback shapes the protocol.\n\n## Quick start\n\n### Cloud relay (zero setup)\n\n```bash\nnpx sideband\n```\n\nStarts a relay-connected daemon, prints a Quick Connect URL. Open it in any browser to call RPCs over E2EE immediately. See [`sideband` CLI docs](packages/cli/README.md).\n\n### Local (direct WebSocket)\n\n```ts\nimport { listen } from \"@sideband/peer/server\";\n\n// Daemon\nconst server = await listen({\n  endpoint: \"ws://localhost:8080\",\n  onConnection(peer) {\n    peer.rpc.handle\u003c{ msg: string }, string\u003e(\"echo\", (p) =\u003e p.msg);\n  },\n});\n```\n\n```ts\nimport { createPeer } from \"@sideband/peer\";\n\n// Browser / client\nconst peer = createPeer({ endpoint: \"ws://localhost:8080\" });\nawait peer.connect();\nconst api = peer.rpc.client\u003c{ echo: (p: { msg: string }) =\u003e string }\u003e();\nconst result = await api[\"echo\"]({ msg: \"hello\" }); // \"hello\"\n```\n\n### Cloud relay (SDK)\n\n```ts\nimport { listen } from \"@sideband/cloud\";\n\n// Daemon — outbound connection to relay, no open port\nconst server = await listen({\n  apiKey: process.env.SIDEBAND_API_KEY,\n  identityKeyPair: await loadOrCreateIdentityKeyPair(),\n  onConnection(peer) {\n    peer.rpc.handle(\"echo\", (p: { msg: string }) =\u003e p.msg);\n  },\n});\n```\n\n```ts\nimport { connect, createMemoryIdentityKeyStore } from \"@sideband/cloud\";\n\n// Browser / client\nconst peer = connect({\n  daemonId: \"d_abc123\",\n  getAccessToken: () =\u003e auth.getSessionToken(),\n  identityKeyStore: createMemoryIdentityKeyStore(),\n});\nawait peer.whenReady();\nconst result = await peer.rpc.call(\"echo\", { msg: \"hello\" }); // \"hello\"\n```\n\n## Packages\n\nMost apps start with `@sideband/peer` (local) or `@sideband/cloud` (relay). Lower-level packages are for custom transports and advanced use cases.\n\n| Package                                                                          | Role                                                       |\n| -------------------------------------------------------------------------------- | ---------------------------------------------------------- |\n| [`@sideband/peer`](https://www.npmjs.com/package/@sideband/peer)                 | High-level SDK                                             |\n| [`@sideband/cloud`](https://www.npmjs.com/package/@sideband/cloud)               | Cloud relay SDK ([sideband.cloud](https://sideband.cloud)) |\n| [`@sideband/protocol`](https://www.npmjs.com/package/@sideband/protocol)         | Wire format, frame types, codecs                           |\n| [`@sideband/transport`](https://www.npmjs.com/package/@sideband/transport)       | Transport ABI and shared utilities                         |\n| [`@sideband/runtime`](https://www.npmjs.com/package/@sideband/runtime)           | Session lifecycle, routing, RPC correlation                |\n| [`@sideband/rpc`](https://www.npmjs.com/package/@sideband/rpc)                   | Typed RPC layer                                            |\n| [`@sideband/secure-relay`](https://www.npmjs.com/package/@sideband/secure-relay) | E2EE relay protocol                                        |\n| [`@sideband/transport-ws`](https://www.npmjs.com/package/@sideband/transport-ws) | WebSocket transport (Browser/Node/Bun)                     |\n| [`sideband`](https://www.npmjs.com/package/sideband)                             | Relay-connected daemon CLI (`npx sideband`)                |\n\n## Develop\n\n```bash\nbun install\nbun test\n```\n\nRequires Bun ≥ 1.3.\n\n## Docs\n\n- **[Getting Started](https://sideband.tech/guide/)** — build your first browser ↔ daemon connection\n- **[Protocols](https://sideband.tech/protocols/)** — SBP wire format, SBRP E2EE, and RPC envelope specs\n\n## License\n\n- **Code**: [Apache-2.0](LICENSE)\n- **Docs**: CC BY 4.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidebandtech%2Fsideband","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsidebandtech%2Fsideband","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidebandtech%2Fsideband/lists"}