mirror of
https://github.com/desplega-ai/agent-fs.git
synced 2026-09-14 20:46:59 +08:00
Add README, LICENSE (MIT), CONTRIBUTING, and .editorconfig
Standard repo files modeled after the agent-swarm repo style: - README.md with badges, feature overview, quick start, and architecture - MIT LICENSE (copyright desplega.ai) - CONTRIBUTING.md with dev setup, project structure, and submission guide - .editorconfig for consistent formatting Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Worker Agent
@@ -0,0 +1,15 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
[*.json]
|
||||
indent_size = 2
|
||||
@@ -0,0 +1,97 @@
|
||||
# Contributing to Agent FS
|
||||
|
||||
Thanks for your interest in contributing to Agent FS!
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Development Setup](#development-setup)
|
||||
- [Running the Project](#running-the-project)
|
||||
- [Code Quality](#code-quality)
|
||||
- [Project Structure](#project-structure)
|
||||
|
||||
---
|
||||
|
||||
## Development Setup
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Bun](https://bun.sh) v1.2+
|
||||
- Git
|
||||
|
||||
### Install Dependencies
|
||||
|
||||
```bash
|
||||
git clone https://github.com/desplega-ai/agent-fs.git
|
||||
cd agent-fs
|
||||
bun install
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Running the Project
|
||||
|
||||
### Type Checking
|
||||
|
||||
```bash
|
||||
bun run typecheck
|
||||
```
|
||||
|
||||
### Tests
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
bun run test
|
||||
|
||||
# With coverage
|
||||
bun run test:coverage
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
# Build CLI binary
|
||||
bun run build
|
||||
```
|
||||
|
||||
Output: `./dist/agentfs`
|
||||
|
||||
---
|
||||
|
||||
## Code Quality
|
||||
|
||||
### Type Checking
|
||||
|
||||
```bash
|
||||
bun run typecheck
|
||||
```
|
||||
|
||||
Run this before committing to catch type errors early.
|
||||
|
||||
---
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
agent-fs/
|
||||
├── packages/
|
||||
│ ├── core/ # Core library — storage, search, identity, database
|
||||
│ ├── cli/ # CLI binary (agentfs)
|
||||
│ ├── mcp/ # MCP server integration
|
||||
│ └── server/ # HTTP server (Hono)
|
||||
├── scripts/ # Build and release scripts
|
||||
├── install.sh # Curl-pipe installer
|
||||
├── package.json # Workspace root
|
||||
└── tsconfig.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Submitting Changes
|
||||
|
||||
1. Fork the repo
|
||||
2. Create a branch (`git checkout -b my-feature`)
|
||||
3. Make your changes
|
||||
4. Run `bun run typecheck` and `bun run test`
|
||||
5. Open a PR
|
||||
|
||||
Join our [Discord](https://discord.gg/KZgfyyDVZa) if you have questions or want to discuss ideas.
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025-2026 desplega.ai
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,94 @@
|
||||
<p align="center">
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<b>A persistent, searchable filesystem for AI agents.</b><br/>
|
||||
<sub>Built by <a href="https://desplega.sh">desplega.sh</a> — by builders, for builders.</sub>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Semantic search** — Index and search files using vector embeddings (OpenAI, Google GenAI, or local llama.cpp)
|
||||
- **Structured storage** — SQLite-backed file operations with metadata and versioning
|
||||
- **S3-compatible sync** — Sync agent workspaces to any S3-compatible object store
|
||||
- **Identity management** — Persistent agent identity files that evolve over time
|
||||
- **MCP integration** — Expose filesystem operations as MCP tools for Claude Code, Codex, and other assistants
|
||||
- **HTTP API** — RESTful server powered by Hono for programmatic access
|
||||
- **CLI** — Single binary (`agentfs`) for local use and scripting
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Install
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/desplega-ai/agent-fs/main/install.sh | sh
|
||||
```
|
||||
|
||||
Or build from source:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/desplega-ai/agent-fs.git
|
||||
cd agent-fs
|
||||
bun install
|
||||
bun run build
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
# Show available commands
|
||||
agentfs --help
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
Agent FS is a Bun monorepo with four packages:
|
||||
|
||||
| Package | Description |
|
||||
|---------|-------------|
|
||||
| `@agentfs/core` | Core library — storage engine, semantic search, identity, S3 sync |
|
||||
| `@agentfs/cli` | CLI binary (`agentfs`) |
|
||||
| `@agentfs/mcp` | MCP server — exposes operations as MCP tools |
|
||||
| `@agentfs/server` | HTTP server — RESTful API powered by Hono |
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
bun install # Install dependencies
|
||||
bun run typecheck # Type checking
|
||||
bun run test # Run tests
|
||||
bun run build # Build CLI binary to dist/agentfs
|
||||
```
|
||||
|
||||
See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full development guide.
|
||||
|
||||
## Releasing
|
||||
|
||||
1. Update `version` in root `package.json`
|
||||
2. Commit the version bump
|
||||
3. Run `./scripts/release.sh`
|
||||
|
||||
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.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions! Whether it's bug reports, feature requests, docs improvements, or code — all are welcome.
|
||||
|
||||
1. Fork the repo
|
||||
2. Create a branch (`git checkout -b my-feature`)
|
||||
3. Make your changes
|
||||
4. Open a PR
|
||||
|
||||
Join our [Discord](https://discord.gg/KZgfyyDVZa) if you have questions or want to discuss ideas.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](./LICENSE) — 2025-2026 [desplega.ai](https://desplega.ai)
|
||||
Reference in New Issue
Block a user