# ox adapter (https://sageox.ai/docs/cli/adapter)

# ox adapter

Discover, install, remove, and inspect the adapter binaries that connect AI coworkers to ox.

## Usage

<Terminal>
  <TerminalCommand>ox adapter [command]</TerminalCommand>
</Terminal>

## Subcommands

| Command | Description |
|---------|-------------|
| `ox adapter list` | List installed and available adapters |
| `ox adapter info <name>` | Show detailed info for an adapter |
| `ox adapter install <name\|github-url>` | Install an adapter from the registry or a GitHub repository |
| `ox adapter remove <name>` | Remove an installed adapter |
| `ox adapter link <path>` | Symlink a local adapter binary for development |
| `ox adapter unlink <name>` | Remove a symlinked adapter |
| `ox adapter verify <name>` | Run compliance tests against an adapter |
| `ox adapter reload` | Signal the daemon to re-scan adapter directories |

## Examples

List what's installed and available:

<Terminal>
  <TerminalCommand>ox adapter list</TerminalCommand>
</Terminal>

Install an adapter by name from the built-in registry, or by GitHub URL. Binaries land in `~/.local/share/ox/adapters/`:

<Terminal>
  <TerminalCommand>ox adapter install cursor</TerminalCommand>
  <TerminalCommand>ox adapter install github.com/sageox/ox-adapters</TerminalCommand>
</Terminal>

Installing from an arbitrary repository, or a curated entry without a pinned checksum, requires opting out of the SageOx-curated checksum:

<Terminal>
  <TerminalCommand>ox adapter install github.com/sageox/ox-adapters --allow-unverified</TerminalCommand>
</Terminal>

## Develop an adapter

Symlink a locally-built binary into the adapter directory, then run it against the protocol compliance suite. `link` is the recommended workflow while developing, the binary must respond to the `info` subcommand:

<Terminal>
  <TerminalCommand>go build -o ./bin/ox-adapter-myagent ./cmd/ox-adapter-myagent</TerminalCommand>
  <TerminalCommand>ox adapter link ./bin/ox-adapter-myagent</TerminalCommand>
  <TerminalCommand>ox adapter verify myagent</TerminalCommand>
</Terminal>

`verify` checks that the adapter correctly implements the `info`, `detect`, and `serve-mode` commands. Remove a symlink again with `ox adapter unlink <name>`, it only removes symlinks, never real binaries.

## What's next

- [ox agent](/docs/cli/agent) - Prime the AI coworker an adapter connects
- [ox daemon](/docs/cli/daemon) - The daemon that `ox adapter reload` signals
- [ox integrate](/docs/cli/integrate) - Wire agents into a repository