CLAW FS

Getting Started

Get ClawFS Running in the Environment You Already Use

The `clawfs` binary is the front door. Use `clawfs up` for preload-based agent launches, `clawfs mount` for FUSE, and `clawfs serve` for user-mode NFS.

curl -fsSL https://clawfs.dev/install.sh | bash
Start With Up Mount With FUSE Serve With NFS Configure Runtime

Step 1

Create an Account and Connect the CLI

Start With the Hosted Experience

For the fastest first run, sign in with email, Google, or GitHub and connect the CLI to your ClawFS account.

clawfs login clawfs whoami

What You Get

  • Secure sign-in for the web app and CLI
  • A straightforward path to hosted evaluation
  • A reusable identity for your workspaces and volumes
  • A clean upgrade path from trial use to team deployment

Default Path

Summon a Volume and Run Your Agent

Default Account Volume

`clawfs up` uses the shared-library path and auto-creates the `default` volume for the current account if you do not choose one.

clawfs up -- codex

Named Volume + CWD-Relative Prefix

Pass `--volume` when you want to recall a specific workspace and `--path` when you want the intercepted prefix anchored relative to the current directory.

clawfs up --volume research-a --path claw -- codex

Default prefix is clawfs relative to the current working directory if no --path is specified.

Current Shipping Modes

  • `clawfs up` for preload-based agent launches
  • `clawfs mount` for direct FUSE mounts
  • `clawfs serve` for user-mode NFS

How to Choose

  • Use `up` when the runtime wants file APIs without a host mount
  • Use `mount` when you control the host mountpoint
  • Use `serve` when you want a networked userspace server

Mode 1

FUSE: Mount ClawFS Directly on the Host

When to Use It

Use FUSE when the agent or developer environment wants a real mount point and the host can support it.

  • Local development
  • Single-node agent runners
  • Workflows that expect POSIX paths directly on the host

Quick Start

clawfs mount --path .clawfs

Defaults to the `default` volume and mounts relative to the current working directory unless you override `--volume` or `--path`.

Direct CLI launch
The front-door wrapper creates the local store/cache/state layout for the volume, then launches the FUSE path behind the scenes.
clawfs mount --volume datasets --path /tmp/clawfs-mnt

Mode 2

NFS: Serve ClawFS Over User-Mode NFS

When to Use It

Use NFS when you want ClawFS running as a user-space server and the client side can mount NFS or connect from another runtime.

  • Remote workers and VMs
  • Containerized runners
  • Cases where you want a clean network boundary between the server and client mount

Quick Start

clawfs serve --listen 127.0.0.1:2049

Defaults to the `default` volume and launches the user-mode NFS gateway for that volume.

Named volume over NFS
Use a volume name when you want a stable shared export:
clawfs serve --volume shared-build --listen 0.0.0.0:2049

Mode 3

Shared Library: In-Process Filesystem Interception for Agents

Status: available for Linux-style preload flows.
`clawfs up` uses the preload shared library automatically. It intercepts filesystem calls for the configured ClawFS prefix and redirects them into ClawFS core logic without requiring a host-level mount.

Default Launch

clawfs up -- codex
clawfs up --volume plan-a --path claw -- python3 your_agent.py

The CLI locates the preload library, sets `LD_PRELOAD`, and prepares the volume-specific local store, cache, and state paths for you.

Runtime Configuration

  • `--path` defaults to clawfs (relative to current working directory)
  • `--volume` lets you select or create a named workspace explicitly
  • `clawfs login` feeds `CLAWFS_API_TOKEN` into hosted flows when needed
  • The CLI manages `CLAWFS_PREFIXES`, `CLAWFS_STORE_PATH`, `CLAWFS_LOCAL_CACHE_PATH`, and `CLAWFS_STATE_PATH` automatically

Configuration

Configure Storage, Credentials, and Runtime Behavior

Storage Provider

Use `--object-provider local|aws|gcs`, then set the backing location with bucket, region, endpoint, and prefix controls.

--object-provider aws --bucket my-clawfs-bucket --region us-west-2 --endpoint https://s3.amazonaws.com --object-prefix agents/team-a

Client State + Cache

Each client keeps local cache and identity state. Override these when you want isolated runners or explicit paths.

--local-cache-path ~/.clawfs/cache --state-path ~/.clawfs/state/client_state.bin --segment-cache-bytes 536870912 --pending-bytes 268435456

Durability + Performance

ClawFS exposes the main durability and cache knobs directly on the CLI instead of hiding them in a daemon config file.

--disable-journal --fsync-on-close --flush-interval-ms 5000 --lookup-cache-ttl-ms 5000 --dir-cache-ttl-ms 5000

Hosted + BYOB Modes

Environment-Driven Runtime Configuration

Hosted Evaluation Example

ClawFS can be configured with environment variables for hosted evaluation environments or self-managed deployments.

CLAWFS_STORAGE_MODE=hosted_free CLAWFS_OBJECT_PROVIDER=aws CLAWFS_BUCKET=clawfs-free CLAWFS_OBJECT_PREFIX=free/account-a/volume-1 CLAWFS_MAX_PENDING_BYTES=268435456 CLAWFS_MAX_SEGMENT_CACHE_BYTES=536870912

Scoped Credentials

For AWS-compatible object stores, ClawFS can consume scoped runtime credentials directly from env.

CLAWFS_AWS_ACCESS_KEY_ID=... CLAWFS_AWS_SECRET_ACCESS_KEY=... CLAWFS_AWS_SESSION_TOKEN=...

Start with the integration path that matches your runtime.

Most teams begin with the hosted experience, then adopt FUSE or NFS when they want more direct control over deployment and storage.

Pick a Plan Open Auth Page See Enterprise Controls