@desplega.ai/agent-fs 0.1.4 → 0.1.5

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.
Files changed (2) hide show
  1. package/README.md +100 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,100 @@
1
+ <p align="center">
2
+ <a href="https://github.com/desplega-ai/agent-fs/stargazers"><img src="https://img.shields.io/github/stars/desplega-ai/agent-fs?style=flat-square&color=yellow" alt="GitHub Stars"></a>
3
+ <a href="https://github.com/desplega-ai/agent-fs/blob/main/LICENSE"><img src="https://img.shields.io/github/license/desplega-ai/agent-fs?style=flat-square" alt="MIT License"></a>
4
+ <a href="https://github.com/desplega-ai/agent-fs/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square" alt="PRs Welcome"></a>
5
+ <a href="https://discord.gg/KZgfyyDVZa"><img src="https://img.shields.io/badge/Discord-Join%20us-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord"></a>
6
+ </p>
7
+
8
+ <p align="center">
9
+ <b>A persistent, searchable filesystem for AI agents.</b><br/>
10
+ <sub>Built by <a href="https://desplega.sh">desplega.sh</a> — by builders, for builders.</sub>
11
+ </p>
12
+
13
+ ---
14
+
15
+ Agent FS gives AI agents a structured filesystem with built-in semantic search, versioning, and identity management. It runs as a CLI, an HTTP server, or an MCP server — so any AI coding assistant can use it as a long-term memory and file store.
16
+
17
+ ## Key Features
18
+
19
+ - **Semantic search** — Index and search files using vector embeddings (OpenAI, Google GenAI, or local llama.cpp)
20
+ - **Structured storage** — SQLite-backed file operations with metadata and versioning
21
+ - **S3-compatible sync** — Sync agent workspaces to any S3-compatible object store
22
+ - **Identity management** — Persistent agent identity files that evolve over time
23
+ - **MCP integration** — Expose filesystem operations as MCP tools for Claude Code, Codex, and other assistants
24
+ - **HTTP API** — RESTful server powered by Hono for programmatic access
25
+ - **CLI** — Single binary (`agent-fs`) for local use and scripting
26
+
27
+ ## Quick Start
28
+
29
+ ### Install
30
+
31
+ ```bash
32
+ curl -fsSL https://raw.githubusercontent.com/desplega-ai/agent-fs/main/install.sh | sh
33
+ ```
34
+
35
+ Or build from source:
36
+
37
+ ```bash
38
+ git clone https://github.com/desplega-ai/agent-fs.git
39
+ cd agent-fs
40
+ bun install
41
+ bun run build
42
+ ```
43
+
44
+ ### Usage
45
+
46
+ ```bash
47
+ # Show available commands
48
+ agent-fs --help
49
+ ```
50
+
51
+ ## Architecture
52
+
53
+ Agent FS is a Bun monorepo with four packages:
54
+
55
+ | Package | Description |
56
+ |---------|-------------|
57
+ | `@desplega.ai/agent-fs-core` | Core library — storage engine, semantic search, identity, S3 sync |
58
+ | `@desplega.ai/agent-fs` | CLI binary (`agent-fs`) |
59
+ | `@desplega.ai/agent-fs-mcp` | MCP server — exposes operations as MCP tools |
60
+ | `@desplega.ai/agent-fs-server` | HTTP server — RESTful API powered by Hono |
61
+
62
+ ## Documentation
63
+
64
+ - [MCP Setup Guide](./docs/mcp-setup.md) — Connect agent-fs to Claude Code, Cursor, or any MCP client
65
+ - [Deployment Guide](./docs/deployment.md) — Local, remote S3, team, and multi-agent deployments
66
+ - [API Reference](./docs/api-reference.md) — HTTP API and OpenAPI spec
67
+
68
+ ## Development
69
+
70
+ ```bash
71
+ bun install # Install dependencies
72
+ bun run typecheck # Type checking
73
+ bun run test # Run tests
74
+ bun run build # Build CLI binary to dist/agent-fs
75
+ ```
76
+
77
+ See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full development guide.
78
+
79
+ ## Releasing
80
+
81
+ 1. Update `version` in root `package.json`
82
+ 2. Commit the version bump
83
+ 3. Run `./scripts/release.sh`
84
+
85
+ This creates a git tag and pushes it, triggering the release workflow which builds binaries for linux-x64, linux-arm64, darwin-x64, darwin-arm64, and windows-x64.
86
+
87
+ ## Contributing
88
+
89
+ We welcome contributions! Whether it's bug reports, feature requests, docs improvements, or code — all are welcome.
90
+
91
+ 1. Fork the repo
92
+ 2. Create a branch (`git checkout -b my-feature`)
93
+ 3. Make your changes
94
+ 4. Open a PR
95
+
96
+ Join our [Discord](https://discord.gg/KZgfyyDVZa) if you have questions or want to discuss ideas.
97
+
98
+ ## License
99
+
100
+ [MIT](./LICENSE) — 2025-2026 [desplega.ai](https://desplega.ai)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@desplega.ai/agent-fs",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
4
4
  "type": "module",
5
5
  "description": "Agent-first filesystem backed by S3",
6
6
  "license": "MIT",
@@ -17,7 +17,7 @@
17
17
  "bin": {
18
18
  "agent-fs": "src/index.ts"
19
19
  },
20
- "files": ["dist"],
20
+ "files": ["dist", "README.md"],
21
21
  "scripts": {
22
22
  "build:npm": "bun build src/index.ts --outfile dist/cli.js --target bun --packages external --minify",
23
23
  "prepublishOnly": "bun run build:npm"