open-agents-bridge

module
v0.13.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2026 License: AGPL-3.0

README

OpenAgents Bridge

中文

Local Bridge CLI that connects AI coding tools with the OpenAgents cloud platform.

Features

  • Connect AI CLIs: Claude Code, Gemini CLI, Goose, Cline, Codex
  • Real-time WebSocket communication
  • End-to-end encryption
  • Permission request forwarding
  • Multi-session management
  • Multi-machine support — run multiple bridge instances on one machine
  • I/O logging — record user input and AI responses for debugging
  • Cross-platform: Windows, Linux, macOS

Install

npm i -g @binoctal/open-agents-bridge
Build from source
make build
Install to system
make install

Quick Start

Pair a machine
# Interactive pairing
open-agents-bridge pair

# With machine name
open-agents-bridge pair --name work-pc
Start the bridge
# Start a machine
open-agents-bridge start --machine work-pc

# With debug logging
open-agents-bridge start --machine work-pc --log-level debug
Manage machines
# List all machines
open-agents-bridge machines

# View machine details
open-agents-bridge machine work-pc
System service
open-agents-bridge service install   # Install as system service
open-agents-bridge service start     # Start service
open-agents-bridge service stop      # Stop service
open-agents-bridge service uninstall # Uninstall service

Configuration

Config files are stored in ~/.open-agents-bridge/:

~/.open-agents-bridge/
├── config.json           # Global config
├── machines/              # Machine configs
│   ├── work-pc.json
│   └── laptop.json
├── logs/                 # Log files
└── sessions/             # Session data
Global config example
{
  "serverUrl": "wss://api.openagents.top",
  "logLevel": "info",
  "cliEnabled": {
    "claude": true,
    "cline": true,
    "codex": true,
    "gemini": true,
  }
}

Supported CLI Tools

CLI Status
Claude Code Supported
Gemini CLI Supported
Goose Supported
Cline Supported
Codex Supported

Development

make deps      # Download dependencies
make build     # Build binary
make test      # Run tests
make build-all # Build for all platforms

License

GNU Affero General Public License v3.0 (AGPL-3.0). See LICENSE.

Trademark and contributing

The Open Agents name and logo are covered by the Trademark Policy (draft). Contributions require agreeing to the CLA described in CONTRIBUTING.md (draft). Release signing is described in docs/release-signing.md.

Directories

Path Synopsis
cmd
internal
acp
api
deploysource
Package deploysource implements the bridge side of add-coolify-hosting's artifact bridge (tasks 4.1-4.3): pack the mission's working source tree and upload it to the platform's deploys/ R2 namespace via the same two-phase protocol previews use (declare -> presigned PUTs -> complete).
Package deploysource implements the bridge side of add-coolify-hosting's artifact bridge (tasks 4.1-4.3): pack the mission's working source tree and upload it to the platform's deploys/ R2 namespace via the same two-phase protocol previews use (declare -> presigned PUTs -> complete).
fingerprint
Package fingerprint derives the machine hint sent at pairing time (machine-model-ia D3).
Package fingerprint derives the machine hint sent at pairing time (machine-model-ia D3).
instancelock
Package instancelock gives a bridge process exclusive ownership of one machine on this machine.
Package instancelock gives a bridge process exclusive ownership of one machine on this machine.
machinekey
Package machinekey implements the machine-bound signing key (bridge-abuse-hardening 4b, design D7).
Package machinekey implements the machine-bound signing key (bridge-abuse-hardening 4b, design D7).
markdown
Package markdown provides lightweight markdown format boundary detection for streaming content splitting.
Package markdown provides lightweight markdown format boundary detection for streaming content splitting.
mcp
preview
Package preview implements the bridge side of add-preview-hosting: after a workflow task's git branch merges into main, optionally build the merged repo as a static site and upload the output to the platform's preview hosting service (tasks 4.1-4.5).
Package preview implements the bridge side of add-preview-hosting: after a workflow task's git branch merges into main, optionally build the merged repo as a static site and upload the output to the platform's preview hosting service (tasks 4.1-4.5).
replay
Package replay defines the recorded-session script format used by the bridge replay test suite (OpenSpec add-replay-testing).
Package replay defines the recorded-session script format used by the bridge replay test suite (OpenSpec add-replay-testing).
serverproof
Package serverproof verifies the control plane's identity before the bridge sends it any credential (bridge-abuse-hardening 5e.1, bridge half).
Package serverproof verifies the control plane's identity before the bridge sends it any credential (bridge-abuse-hardening 5e.1, bridge half).
utf8safe
Package utf8safe turns arbitrary-size read chunks into strings that never split a UTF-8 rune (fix-seed-audit-blockers S5: PTY output arrives in 4096 byte reads, and a 3-byte CJK rune landing across the boundary became two U+FFFD replacement chars in the web terminal).
Package utf8safe turns arbitrary-size read chunks into strings that never split a UTF-8 rune (fix-seed-audit-blockers S5: PTY output arrives in 4096 byte reads, and a 3-byte CJK rune landing across the boundary became two U+FFFD replacement chars in the web terminal).
scripts
e2e/shim command
Command shim is the replay agent used by the parity e2e recipes (OpenSpec add-parity-e2e-verification).
Command shim is the replay agent used by the parity e2e recipes (OpenSpec add-parity-e2e-verification).
release-sign command
Command release-sign manages the Ed25519 key that signs release checksums.txt files (bridge-abuse-hardening 5e.2).
Command release-sign manages the Ed25519 key that signs release checksums.txt files (bridge-abuse-hardening 5e.2).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL