VeryFS.Server

Project Hub | Call for Contributions

VeryFS.Server is the ASP.NET Core hosting package for VeryFS, an AI-native Virtual File System.

It turns VeryFS.Core, VeryFS.Drivers.Local, and the external driver packages into a runnable HTTP service for applications, automation tools, and AI agents.

Run

dotnet run --project src\VeryFS.Server\VeryFS.Server.csproj

Docker

docker compose up --build

The default Compose file expects PostgreSQL connection information through environment variables and exposes the server on port 5080.

Mount Form Schema

GET /v1/drivers returns each driver definition with a mountSchema object. The schema is intentionally small and UI-oriented:

{
  "version": "veryfs.mount-form.v1",
  "title": "GitLab repository",
  "quickStart": "repositoryUrl",
  "token": {
    "configKey": "tokenSecret",
    "label": "Token",
    "permissionTitle": "GitLab token permissions",
    "scopes": ["read_api"],
    "description": "Read-only repository browsing does not require api scope."
  },
  "fields": [
    { "path": "config.baseUrl", "label": "Base URL", "type": "url", "required": false },
    { "path": "config.projectPath", "label": "Project path", "type": "text", "required": true }
  ]
}

Clients should treat unknown field types as text inputs. External driver descriptors stored in PostgreSQL can provide their own config_schema_json in the same shape.

POST /v1/mounts/test accepts the same mount shape plus optional transientSecrets. It validates config and asks the driver to list the target root without creating a mount or saving secrets.

License

MIT License.