@desplega.ai/agent-fs 0.5.4 → 0.6.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
@@ -63,6 +63,43 @@ Agent FS is a Bun monorepo with four packages:
63
63
  | `@desplega.ai/agent-fs-mcp` | MCP stdio proxy + tool registration for the HTTP server |
64
64
  | `@desplega.ai/agent-fs-server` | HTTP server — RESTful API powered by Hono |
65
65
 
66
+ ## FUSE mount (Linux)
67
+
68
+ agent-fs can expose your drives as a Linux FUSE filesystem so agents can use plain shell verbs (`cat`, `grep`, `mv`, `rm`) against agent-fs content.
69
+
70
+ ```bash
71
+ # Linux only — the FUSE helper sub-package auto-installs via optionalDependencies.
72
+ npm install -g @desplega.ai/agent-fs
73
+ agent-fs daemon start
74
+ agent-fs mount /mnt/agent-fs
75
+ ```
76
+
77
+ **Requirements**
78
+
79
+ - Linux x86_64 or aarch64. macOS and Windows are not supported (FUSE is a Linux kernel feature here).
80
+ - `/dev/fuse` must be accessible. In Docker, run with `--cap-add SYS_ADMIN --device /dev/fuse`.
81
+ - Sandboxes that use gVisor (GKE Sandbox, Cloud Run gen1), GitHub Codespaces, Modal sandboxes, or Fly.io Machines cannot mount FUSE — fall back to the CLI/MCP path.
82
+
83
+ **Local-dev escape hatch (`AGENT_FS_FUSE_BIN`)**
84
+
85
+ If you're building the helper from source (e.g. macOS dev host or a custom Linux build), point the CLI at your local binary:
86
+
87
+ ```bash
88
+ cd packages/fuse-helper && cargo build --release
89
+ export AGENT_FS_FUSE_BIN="$PWD/target/release/agent-fs-fuse"
90
+ agent-fs mount /tmp/m
91
+ ```
92
+
93
+ `AGENT_FS_FUSE_BIN` takes precedence over the auto-resolved sub-package binary.
94
+
95
+ **macOS testing harness**
96
+
97
+ macOS can build the helper but not mount it. Use the Docker harness to test mount behaviour from a Mac host:
98
+
99
+ ```bash
100
+ bash packages/fuse-helper/docker/run-mount-test.sh
101
+ ```
102
+
66
103
  ## Documentation
67
104
 
68
105
  - [MCP Setup Guide](./docs/mcp-setup.md) — Connect agent-fs to Claude Code, Cursor, or any MCP client