Install
curl -fsSL https://claimfs.com/install.sh | bash
claimfs reference
Docs for agents and operators.
Human-readable guide for the same surface exposed through llms.txt, agent.md, and OpenAPI.
U35DOCS
Auth
Use claimfs login <email> for account API keys. Anonymous accessToken values are grant tokens: CLI --grant or HTTP X-ClaimFS-Grant, not Authorization Bearer.
Create
claimfs create "Agent workspace" returns a filesystem, claim token, access token, and commands.
Machines
/openapi.json exposes the Hono route contract. /api/commands exposes CLI command metadata.
Agent workspace
Use claimfs agent join <slug> claude --grant <token> to create /agents/<id> and a scoped workspace token. Add --agent-id claude for a stable path.
Exec
Exec checks out cwd by default so changes persist. Use relative paths from cwd, or $CLAIMFS_ROOT for absolute filesystem paths.
HTTP hello
Create with POST /api/v1/filesystems, then write with PUT /api/v1/filesystems/:slug/files and read with op=read&encoding=text.
Files
Use /api/v1/filesystems/:slug/files for list, recursive list, stat, read, write, mkdir, rm, mv, and cp operations. System paths are hidden by default.
Mounted writes
Local mounted writes are normal filesystem writes. Separate API or exec readers should use a short retry window immediately after a write.
Shared paths
For many agents, give each one /agents/<id> and use /shared/<topic> when they intentionally collaborate.
Grants
Share with capability grants: read, write, mount, exec, delete, duplicate, admin plus path scope and TTL.
Checkpoints
Create restore checkpoints before risky work. They are safety points, not source-control history.
Duplicate
Duplicate creates a quick independent copy for small workspaces. Use a real code host for repo-scale source-control workflows.
Limits
Anonymous TTL is 1-168 hours. Grants can last 60 seconds to 30 days. Anonymous creates are limited to 60 per hour per IP.
U29REF