Choose Where to Mount
Choose the API based on what you want to mount and where you want the directory to appear:
Local filesystem mounts are writable. Passing
true as the third argument to FilesystemClient.mount() raises ReadOnlyMountNotSupportedError. Use a read-only sandbox filesystem mount for shared filesystem inputs, or a read-only Git mount for repository content. Sandbox filesystem mounts also support snapshot pins.
Install the file-system extension once on macOS. Linux needs no setup.
Choose a Mode
tl fs mount itself is always writable: a file system is the shared writable surface, so read-only is expressed where the consumer attaches — as a read_only sandbox mount — while --ro lives on tl git mount, where read-only views are a repository concept.
Writable Mounts
Writable mounts are for agent sessions that create or modify files. The agent writes files in the mount; writes enter a crash-safe local journal and settled changes replicate as durable server WAL checkpoints. The server applies each acknowledged checkpoint to the shared timeline. Create the filesystem first and install and authenticate the CLI or SDK. Local SDK mounts also require the separately installedtl CLI with filesystem mount support. Then mount it:
- CLI
- Python
- TypeScript
snapshot(message?), status(), and unmount(discard?). unmount() keeps recoverable session state; pass true only to discard changes not yet uploaded. See Manage Sessions for mounting again and inspecting existing mounts.
Autosave is always on for writable mounts. Changes normally reach the shared timeline about 750ms after they settle plus upload/server time; a continuously-writing agent checkpoints at least every 5 seconds. The server does not acknowledge the checkpoint until verification and shared-head publication complete. tl fs snapshot /work -m "..." keeps the command’s exact state permanently and returns only after the durable snapshot receipt exists. If autosave already published that state, the server promotes the existing automatic save in place—no file bytes are uploaded and no duplicate content version is created. You can safely unmount as soon as the command succeeds. It is a quiet no-op only when the current save is already permanent.
Remounting a file system this machine has a detached session for resumes that session, unsaved local changes included.
Read-only Mounts
Read-only mounts are for inputs and shared assets: follow the current state to roll out updates to many consumers, or pin a fixed version for reproducibility. Read-only is expressed on the consumer, not ontl fs mount:
-
Sandboxes: pass
read_onlyon the mount when creating the sandbox (or attaching to a running one). The guest directory follows the file system’s current state and refuses writes withEROFS, enforced down to the storage credential.See Mount Filesystems for the Python, TypeScript, and HTTP equivalents. -
Git repositories:
tl git mount --rogives a stateless read-only view of a branch, a pinned commit, or a subtree:
Session Operations
Use session operations to inspect local changes, resume after a sandbox restart, browse history, create permanent snapshots, inspect a session, and clean up.fork, or read individual files at a snapshot with read_file(path, version=...). See Manage Sessions.
See Manage Sessions.
Mounting in Sandboxes
The simplest way to mount a file system into a Tensorlake sandbox is through the sandbox API: pass the file system’s name and a mount path when creating the sandbox (or attach it to a running one), and the mount appears as an ordinary directory with no credentials to manage:read_only and prefetch options are available. See Mount Filesystems for the full guide, including warm-pool claims and runtime attach/detach.
Alternatively, mount from inside the guest with the same tl fs mount commands. The guest needs one scoped credential to attach a file system:
Read-only Mounts
Use pinned and following mounts for fixed inputs and shared assets.
Distribute Files
Roll out manuals, skills, configs, and tools to agent fleets.
Manage Sessions
Inspect status, resume, restore, and clean up.
Core Concepts
File systems, mounts, sessions, autosave checkpoints, snapshots, and publishing.