@desplega.ai/agent-fs 0.6.1 → 0.7.2

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
@@ -69,7 +69,9 @@ agent-fs can expose your drives as a Linux FUSE filesystem so agents can use pla
69
69
 
70
70
  ```bash
71
71
  # Linux only — the FUSE helper sub-package auto-installs via optionalDependencies.
72
- npm install -g @desplega.ai/agent-fs
72
+ # Use Bun's installer; stock Ubuntu/Debian Node (18.x) chokes on a dep's
73
+ # postinstall and aborts the global install.
74
+ bun install -g @desplega.ai/agent-fs
73
75
  agent-fs daemon start
74
76
  agent-fs mount /mnt/agent-fs
75
77
  ```
@@ -92,6 +94,25 @@ agent-fs mount /tmp/m
92
94
 
93
95
  `AGENT_FS_FUSE_BIN` takes precedence over the auto-resolved sub-package binary.
94
96
 
97
+ **Remote mount (`--remote`)**
98
+
99
+ 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:
100
+
101
+ ```bash
102
+ agent-fs mount /mnt/agent-fs --remote \
103
+ --api-url https://my-agent-fs.example.com \
104
+ --api-key "$AGENT_FS_API_KEY"
105
+ ```
106
+
107
+ 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`:
108
+
109
+ ```bash
110
+ # Spins up MinIO, a host-side daemon, and a Docker container with fuse3.
111
+ # Mounts via --remote against the daemon's HTTP API and exercises ~8 ops.
112
+ # Requires Docker Desktop / OrbStack on Mac.
113
+ bun run scripts/e2e-remote-mount.ts
114
+ ```
115
+
95
116
  **macOS testing harness**
96
117
 
97
118
  macOS can build the helper but not mount it. Use the Docker harness to test mount behaviour from a Mac host:
@@ -100,8 +121,13 @@ macOS can build the helper but not mount it. Use the Docker harness to test moun
100
121
  bash packages/fuse-helper/docker/run-mount-test.sh
101
122
  ```
102
123
 
124
+ **Per-environment guides**
125
+
126
+ 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.
127
+
103
128
  ## Documentation
104
129
 
130
+ - [Mounting Guides](./docs/mounting/README.md) — General overview + per-env guides (Sprite, E2B, Hetzner)
105
131
  - [MCP Setup Guide](./docs/mcp-setup.md) — Connect agent-fs to Claude Code, Cursor, or any MCP client
106
132
  - [Deployment Guide](./docs/deployment.md) — Local, remote S3, team, and multi-agent deployments
107
133
  - [API Reference](./docs/api-reference.md) — HTTP API and OpenAPI spec