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` to mount through FUSE or NFS, and `clawfs serve` to launch an explicit user-mode NFS server.

Linux / macOS: curl -fsSL https://clawfs.dev/install.sh | bash Windows (PowerShell): iwr https://clawfs.dev/install.ps1 -UseBasicParsing | iex

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 -- claude

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 -- claude

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

Configuration

Configure Storage, Credentials, and Runtime Behavior

Storage Provider (Pro only)

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

Start with the integration path that matches your runtime.

Most teams begin with the hosted experience, then adopt `mount`, `serve`, or preload-based launches when they want more direct control over deployment and storage.