Documentation

Start with a working volume, then add the tools your application needs.

Set up a volume

• Getting started: install the package and save your first file.
• Browser setup: configure HTTPS and cross-origin isolation.
• Volumes and lifecycle: understand volume names, ownership, and closing.

Work with files

• Files and directories: create, read, write, and remove files.
• Persistence and recovery: choose save points and recover interrupted work.
• Volume Explorer: inspect and edit storage while your app runs.
• File preview extensions: add renderers for your file formats.

Add a plugin

• Plugins: available community and premium capabilities, plus planned cloud sync.
• File subscriptions: react to file changes and recover a current view.

Choose an API

• TypeScript: create a volume and read or write files.
• React SDK preview: connect components to a volume with providers and subscribed reads.
• React API reference: look up providers, hooks, and lifecycle commands.
• Effect v4 adapter: manage scoped volumes, use the FileSystem service, and stream file changes. Requires stable Effect v4, starting at 4.0.0 and excluding v5 and prereleases.

Connect an integration

• PGlite: store a PostgreSQL database in a volume.
• just-bash: run shell commands against workspace files.
• DuckDB: use the experimental analytics adapter with a custom engine.
• EdgeJS: use the experimental JavaScript runtime with a custom host.

Look up a detail

• API overview: imports, volume options, and inspection APIs.
• Troubleshooting: startup, ownership, quota, and recovery errors.
• Licensing: community and commercial terms.

For the design behind the library, read why OPFS VFS exists. To try it first, open a demo.