/ in a file’s path as a folder.
Setup
- Create a bucket at huggingface.co/new-bucket:
pick the owner (an account or an organization), a name and the visibility.
The bucket’s id is
<owner>/<name>, for examplemy-user/my-data. - Create a token at huggingface.co/settings/tokens: Read for a read mount, Write to upload. A fine-grained token needs read access, or write access to upload, on the bucket’s namespace.
Connect
- YAML
- Python
- TypeScript
workspace.yaml
Layout
- A folder exists only while it holds a file, so
mkdircreates nothing.key_prefix(keyPrefixin TypeScript) mounts one folder as the root. mvandrmdirare not supported.grep -r,findanddustop after 1000 files; a glob matching more,tar -c,cp -randrm -rare refused.- TypeScript runs it in Node only, with the
opendalpackage installed. Python needs thehf-bucketsextra.
Sample runs
write mount, cp, > and rm change the bucket in place. A bucket
keeps no history, so a removed file is gone for good.
SDK guides
Python
Every config field, the VFS.md and write support.
TypeScript
Every config field, the VFS.md and write support.