# Documentation

> Set up OPFS VFS, work with files, and connect databases, shells, and developer tools.

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

## Set up a volume

- [Getting started](/docs/getting-started/): install the package and save your first file.
- [Browser setup](/docs/guides/browser-setup/): configure HTTPS and cross-origin isolation.
- [Volumes and lifecycle](/docs/concepts/): understand volume names, ownership, and closing.

## Work with files

- [Files and directories](/docs/guides/files-and-directories/): create, read, write, and remove files.
- [Persistence and recovery](/docs/guides/persistence/): choose save points and recover interrupted work.
- [Volume Explorer](/docs/guides/devtools/): inspect and edit storage while your app runs.
- [File preview extensions](/docs/guides/file-previews/): add renderers for your file formats.

## Add a plugin

- [Plugins](/docs/plugins/): available community and premium capabilities, plus planned cloud sync.
- [File subscriptions](/docs/plugins/subscriptions/): react to file changes and recover a current view.

## Choose an API

- [TypeScript](/docs/getting-started/): create a volume and read or write files.
- [React SDK preview](/docs/react/): connect components to a volume with providers and subscribed reads.
- [React API reference](/docs/react/reference/): look up providers, hooks, and lifecycle commands.
- [Effect v4 adapter](/docs/effect/): 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](/docs/integrations/pglite/): store a PostgreSQL database in a volume.
- [just-bash](/docs/integrations/just-bash/): run shell commands against workspace files.
- [DuckDB](/docs/integrations/duckdb/): use the experimental analytics adapter with a custom engine.
- [EdgeJS](/docs/integrations/edgejs/): use the experimental JavaScript runtime with a custom host.

## Look up a detail

- [API overview](/docs/reference/): imports, volume options, and inspection APIs.
- [Troubleshooting](/docs/troubleshooting/): startup, ownership, quota, and recovery errors.
- [Licensing](/licensing/): community and commercial terms.

For the design behind the library, read [why OPFS VFS exists](/motivation/). To try it first, open a [demo](/demos/).