Skip to main content


Less than 1 minute


Install using package manager of choice npm,yarn,pnpm:

npm install --save @dxos/client


If using DXOS in a browser environment, set up your Vite config.

Create and initialize a Client:

import { Client } from '@dxos/client';

// create a client
const client = new Client();

const main = async () => {
  await client.initialize();
  // use client here



An Options object can be passed to Client(). See configuration examples.

To begin manipulating data, we must create an identity, and join or create a space.