# @dxos/client

> DXOS Client API.

Latest version **0.16.0** (published 2026-10-19) · FSL-1.1-Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @dxos/client
pnpm add @dxos/client
yarn add @dxos/client
bun add @dxos/client
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; large bundle; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.16.0 |
| Published | 2026-10-19 |
| First published | 2020-06-26 |
| Weekly downloads | 0 |
| License | FSL-1.1-Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=12.0.0 |
| Dependencies | 37 |
| Unpacked size | 39.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 532 |
| Author | DXOS.org |
| Maintainers | richburdon, marik_d, wittjosiah, dxos-bot, mykola-vrmchk |

## Links

- npm: https://www.npmjs.com/package/@dxos/client
- Repository: https://github.com/dxos/dxos
- Homepage: https://dxos.org
- Issues: https://github.com/dxos/dxos/issues
- npm.io page: https://npm.io/package/@dxos/client

## Dependencies (37)

- [effect](https://npm.io/package/effect.md) 4.0.4
- [@dxos/log](https://npm.io/package/@dxos/log.md) 0.16.0
- [@dxos/rpc](https://npm.io/package/@dxos/rpc.md) 0.16.0
- [@dxos/blob](https://npm.io/package/@dxos/blob.md) 0.16.0
- [@dxos/echo](https://npm.io/package/@dxos/echo.md) 0.16.0
- [@dxos/keys](https://npm.io/package/@dxos/keys.md) 0.16.0
- [@dxos/util](https://npm.io/package/@dxos/util.md) 0.16.0
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^4.0.0
- [@dxos/async](https://npm.io/package/@dxos/async.md) 0.16.0
- [@dxos/debug](https://npm.io/package/@dxos/debug.md) 0.16.0
- [@dxos/config](https://npm.io/package/@dxos/config.md) 0.16.0
- [@dxos/effect](https://npm.io/package/@dxos/effect.md) 0.16.0
- [@dxos/errors](https://npm.io/package/@dxos/errors.md) 0.16.0
- [@dxos/context](https://npm.io/package/@dxos/context.md) 0.16.0
- [@dxos/tracing](https://npm.io/package/@dxos/tracing.md) 0.16.0
- [@dxos/node-std](https://npm.io/package/@dxos/node-std.md) 0.16.0
- [@dxos/invariant](https://npm.io/package/@dxos/invariant.md) 0.16.0
- [@dxos/messaging](https://npm.io/package/@dxos/messaging.md) 0.16.0
- [@dxos/protocols](https://npm.io/package/@dxos/protocols.md) 0.16.0
- [@dxos/timeframe](https://npm.io/package/@dxos/timeframe.md) 0.16.0
- [@dxos/rpc-tunnel](https://npm.io/package/@dxos/rpc-tunnel.md) 0.16.0
- [@dxos/sql-sqlite](https://npm.io/package/@dxos/sql-sqlite.md) 0.16.0
- [@dxos/credentials](https://npm.io/package/@dxos/credentials.md) 0.16.0
- [@dxos/echo-client](https://npm.io/package/@dxos/echo-client.md) 0.16.0
- [@dxos/edge-client](https://npm.io/package/@dxos/edge-client.md) 0.16.0
- [@bufbuild/protobuf](https://npm.io/package/@bufbuild/protobuf.md) 2.11.0
- [lodash.isequalwith](https://npm.io/package/lodash.isequalwith.md) ^4.4.0
- [@dxos/echo-protocol](https://npm.io/package/@dxos/echo-protocol.md) 0.16.0
- [@dxos/websocket-rpc](https://npm.io/package/@dxos/websocket-rpc.md) 0.16.0
- [@automerge/automerge](https://npm.io/package/@automerge/automerge.md) 3.5.0
- [@dxos/client-protocol](https://npm.io/package/@dxos/client-protocol.md) 0.16.0
- [@dxos/client-services](https://npm.io/package/@dxos/client-services.md) 0.16.0
- [@dxos/compute-runtime](https://npm.io/package/@dxos/compute-runtime.md) 0.16.0
- [@dxos/network-manager](https://npm.io/package/@dxos/network-manager.md) 0.16.0
- [@dxos/worker-framework](https://npm.io/package/@dxos/worker-framework.md) 0.16.0
- [@effect/platform-browser](https://npm.io/package/@effect/platform-browser.md) 4.0.4
- [@automerge/automerge-repo](https://npm.io/package/@automerge/automerge-repo.md) 2.6.0-subduction.48

## Recent versions

- 0.16.0 (latest) — 2026-10-19
- 0.16.0-next-60712ab191a99ba90316cc4be753e9e11b17100a (next) — 2026-10-19
- 0.9.1-main.c7dcc2e112 (main) — 2026-06-19
- 0.7.5-labs.d199c0f (labs) — 2025-03-12
- 2.33.9-dev.a2586ac4 (dev) — 2022-08-17
- 0.14.0 — 2026-10-10
- 0.13.0 — 2026-10-07
- 0.12.0-next-73daef452f1464b62efdbca75fb0067c1066f264 — 2026-08-27
- 0.12.0-next-2800d0376abcc62d5544afdd744b16b2b960434e — 2026-08-27
- 0.12.0-next-2be9f24c465d98f4bd186aa03ece788902e6c17a — 2026-08-27
- 1.0.0-next-bbabc02363f18d7643ea4160e3a7a7809870fd0d — 2026-08-10
- 0.11.1 — 2026-08-05
- 0.11.0 — 2026-08-05
- 0.10.0 — 2026-07-02
- 0.9.1-staging.ee54ba693a — 2026-07-02
- … 3379 more at https://npm.io/package/@dxos/client/versions

## README

# @dxos/client

Core DXOS Client API.

## Installation

```bash
pnpm i @dxos/client
```

## Usage

Create a client object like this:

```ts
import { Client } from '@dxos/client';
const client = new Client();
```

## Documentation

- [⚡️ Quick Start](https://docs.dxos.org/guide/quick-start)
- [📖 Developer Guide](https://docs.dxos.org/guide/echo/)
- [📚 API Reference](https://docs.dxos.org/api/@dxos/client)

## DXOS Resources

- [Website](https://dxos.org)
- [Developer Documentation](https://docs.dxos.org)
- Talk to us on [Discord](https://dxos.org/discord)

## Contributions

Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).

License: [FSL-1.1-Apache-2.0](./LICENSE) Copyright 2022 © DXOS

## Worker architecture

```mermaid
sequenceDiagram
    participant C1 as Client 1 (Leader)
    participant Coord as Coordinator (SharedWorker)
    participant W as Worker (Dedicated)
    participant C2 as Client 2 (Follower)

    Note over C1, W: 1. Leader Initialization
    C1->>Coord: Connect
    C1->>C1: Request Leader Lock (Success)
    C1->>W: Spawn Worker
    W->>C1: msg: listening
    Note right of C1: Wait for 'listening' to ensure worker<br/>doesn't miss subsequent messages
    C1->>W: msg: init (Client1_ID)
    W->>C1: msg: ready (LivenessKey)
    C1->>Coord: msg: new-leader (Leader_ID)

    Note over C1, W: 2. Client 1 Self-Connection
    C1->>Coord: msg: request-port (Client1_ID)
    Note right of Coord: Maps Client1_ID -> C1 Port
    Coord->>C1: msg: request-port (Client1_ID)
    Note right of C1: Leader acts on request
    C1->>W: msg: start-session (Client1_ID)
    W->>C1: msg: session (Client1_ID, Ports)
    C1->>Coord: msg: provide-port (Client1_ID, Ports)
    Coord->>C1: msg: provide-port (Client1_ID, Ports)
    Note right of C1: Client 1 Services Connected

    Note over C2, W: 3. Client 2 Connection
    C2->>Coord: Connect
    C2->>C2: Request Leader Lock (Waits/Fails)
    loop Polling
        C2->>Coord: msg: request-port (Client2_ID)
    end
    Note right of Coord: Maps Client2_ID -> C2 Port
    Coord->>C1: msg: request-port (Client2_ID)
    Note right of C1: Leader acts on request
    C1->>W: msg: start-session (Client2_ID)
    W->>C1: msg: session (Client2_ID, Ports)
    C1->>Coord: msg: provide-port (Client2_ID, Ports)
    Coord->>C2: msg: provide-port (Client2_ID, Ports)
    Note right of C2: Client 2 Services Connected
```

---
_Source: https://npm.io/package/@dxos/client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
