About this project

sapphire-framework is a Rust crate that provides the foundation for a local‑first, file‑based workspace designed for human‑agent collaboration. It indexes plain‑text files (Markdown, JSON, JSONL, etc.) and offers full‑text search via Tantivy, optional vector search through FastEmbed or external providers, and a simple API for reading, writing, and listing files. The workspace is discovered by walking up the directory tree to find a marker directory, and each workspace gets a stable UUID derived from its path. Configuration can be supplied through a config.toml file or environment variables, enabling choices such as the storage backend (redb or none), embedding provider, model, and API keys. The library supports incremental sync, automatic index updates on file changes, and optional remote backends for concurrent editing, while git is used manually for version control. It is licensed under MIT or Apache‑2.0.