Skip to main content
SupabaseVFS mounts one Supabase Storage bucket: every object becomes a file and every / in a key a folder. It reaches Supabase through the Storage S3 API. Set up credentials as in Supabase setup.

Install

Configure

project_ref builds the endpoint https://<project_ref>.storage.supabase.co/storage/v1/s3; endpoint_url replaces it. region is required to sign requests: use the one on the project’s Storage settings page. A mount takes MountMode.READ, WRITE or EXEC.

Fields

float
default:"30"
Seconds a request may wait to connect, or between two reads of its answer, before it fails; a download that keeps flowing is never cut off.
str
required
Name of the bucket to mount.
str
required
Provider region every request is signed for. Most providers also build their endpoint URL from it unless endpoint_url is set.
str
Endpoint URL that replaces the one the provider derives.
str
secret
Access key ID; set it with secret_access_key. Unset uses the AWS credential chain.
str
secret
Secret access key paired with access_key_id.
str
secret
Session token for temporary credentials, sent with the access key pair.
str
Named profile in the shared AWS config and credentials files that supplies credentials when no access key pair is given.
bool
default:"True"
Address the bucket in the URL path (<endpoint>/<bucket>/<key>) instead of as a subdomain of the endpoint.
str
Key prefix inside the bucket that the mount treats as its root; keys outside it are not visible. Leading slashes are dropped and a trailing / is added.
str
secret
Proxy URL for every HTTP and HTTPS request to the endpoint.
str
Supabase project reference. It builds the endpoint https://<project_ref>.storage.supabase.co/storage/v1/s3 unless endpoint_url is set; one of the two is required.
Fields marked secret are redacted in snapshots.

Authentication

Credentials come from the first of:
  1. access_key_id and secret_access_key, a Storage S3 access key, with session_token for temporary credentials.
  2. aws_profile, a profile in ~/.aws/credentials.
  3. The AWS credential chain: environment variables, then the instance or container role.
Use an S3 access key, not the project’s anon or service_role key. An S3 access key reaches every bucket in the project and bypasses Row Level Security, so keep it on a server. A request the credentials may not make answers Permission denied.

Layout

/supabase/data/file.txt is the key data/file.txt. Folders come from the / in keys; Supabase stores no folder objects.

Behavior

  • Key prefix: key_prefix="users/42/" mounts only that part of the bucket, so /supabase/notes.md is the key users/42/notes.md.
  • Path style: Supabase takes only path-style URLs, so path_style defaults to True.

Integration

Supabase answers these commands through its own API, so fewer objects are read. See Integration.
  • find: one recursive listing.
  • du: one recursive listing.
  • ls -R and tree: one recursive listing.

VFS.md

The VFS.md an agent reads with Supabase mounted at /<path>. <mode> is the mount’s mode: read, write or exec. The commands shown are those of a write mount.
Virtual FilesystemSupported Unix Commands for VFSUnix commands work on each path as on a local filesystem, as far as the path supports them:Limitations of Unix Commands for VFSWhere a path differs from a local filesystem:Run man <cmd> or <cmd> --help for one command’s usage.