AFFiNE

AFFiNE is a next-generation all-in-one workspace where you can write, draw, and plan all at once. It is a privacy-focused, local-first, and open-source alternative to Notion and Miro, featuring a hyper-fused platform with fully merged docs, whiteboards, and databases. Protocol Launcher allows you to generate deep links to open and configure resources in AFFiNE.

Usage

There are two ways to use this library:

• On-Demand import from subpaths enables tree-shaking and keeps bundles small.
• Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand

Recommended. Optimized for production.

Full Import

Convenient. Good for quick scripts.

Open AFFiNE

On-Demand

import { open } from 'protocol-launcher/affine'

const url = open()

Open AFFiNE

Open Document

On-Demand

import { openFile } from 'protocol-launcher/affine'

const url = openFile({
  workspaceId: '4f5a46cf-5eeb-4130-beda-25b438cd8c60',
  docId: 'ykchLzhvFXEUMwJu_spHY',
})

Open in AFFiNE