@desplega.ai/agent-fs 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -92,6 +92,25 @@ agent-fs mount /tmp/m
92
92
 
93
93
  `AGENT_FS_FUSE_BIN` takes precedence over the auto-resolved sub-package binary.
94
94
 
95
+ **Remote mount (`--remote`)**
96
+
97
+ When your agents run inside a sandbox that can't host a local daemon (Sprite, E2B, ephemeral CI runners), point the mount at a remote agent-fs HTTP API instead of a local Unix socket:
98
+
99
+ ```bash
100
+ agent-fs mount /mnt/agent-fs --remote \
101
+ --api-url https://my-agent-fs.example.com \
102
+ --api-key "$AGENT_FS_API_KEY"
103
+ ```
104
+
105
+ The helper talks to the remote API directly — no local daemon, no S3 credentials in the sandbox. End-to-end coverage for this topology lives at `scripts/e2e-remote-mount.ts`:
106
+
107
+ ```bash
108
+ # Spins up MinIO, a host-side daemon, and a Docker container with fuse3.
109
+ # Mounts via --remote against the daemon's HTTP API and exercises ~8 ops.
110
+ # Requires Docker Desktop / OrbStack on Mac.
111
+ bun run scripts/e2e-remote-mount.ts
112
+ ```
113
+
95
114
  **macOS testing harness**
96
115
 
97
116
  macOS can build the helper but not mount it. Use the Docker harness to test mount behaviour from a Mac host:
@@ -100,8 +119,13 @@ macOS can build the helper but not mount it. Use the Docker harness to test moun
100
119
  bash packages/fuse-helper/docker/run-mount-test.sh
101
120
  ```
102
121
 
122
+ **Per-environment guides**
123
+
124
+ See [`docs/mounting/`](./docs/mounting/README.md) for the general overview plus step-by-step guides for [Sprite](./docs/mounting/sprite.md), [E2B](./docs/mounting/e2b.md), and [Hetzner Cloud](./docs/mounting/hetzner.md). Existing FUSE references — [`fuse-mount.md`](./docs/fuse-mount.md), [`fuse-compat.md`](./docs/fuse-compat.md), [`fuse-troubleshooting.md`](./docs/fuse-troubleshooting.md) — cover mount semantics, sandbox compatibility, and the full error catalogue.
125
+
103
126
  ## Documentation
104
127
 
128
+ - [Mounting Guides](./docs/mounting/README.md) — General overview + per-env guides (Sprite, E2B, Hetzner)
105
129
  - [MCP Setup Guide](./docs/mcp-setup.md) — Connect agent-fs to Claude Code, Cursor, or any MCP client
106
130
  - [Deployment Guide](./docs/deployment.md) — Local, remote S3, team, and multi-agent deployments
107
131
  - [API Reference](./docs/api-reference.md) — HTTP API and OpenAPI spec