How guepard-corp/gfs works
GFS provides Git-like version control for database state: users initialize repositories, query and change databases, commit snapshots, then inspect history or switch branches and revisions. The CLI is the main user-facing workflow; an MCP server exposes operations to AI agents. Domain use cases sit above repository, provider, compute, and storage abstractions. Separate product branches include the web console, PostgreSQL proxy, and experimental lazy-clone extension. The README documents capabilities beyond the sampled implementations; dashed links mark workflow relationships that the excerpts do not establish.
Main entry points: cmd_query.rs GFS CLI · repository Repository operations · gfs_repository.rs Repository adapter · ports Domain ports
Components 20
User interfaces
- GFS CLI
crates/applications/cli/src/commands/cmd_query.rs - MCP server
crates/applications/mcp/src/tools.rs - Web console
crates/applications/console/src/main.rs - Console UI
crates/applications/console/web/src/App.tsx
Version control
- Repository operations
crates/domain/src/usecases/repository - Repository adapter
crates/domain/src/adapters/gfs_repository.rs - Repository layout
crates/domain/src/repo_utils/repo_layout.rs - Commit model
crates/domain/src/model/commit.rs - Repository config
crates/domain/src/model/config.rs - Domain ports
crates/domain/src/ports
Database runtime
- Database providers
crates/adapters/db-providers/src - Compute runtime
crates/adapters/compute-docker/src/lib.rs - Database storage
crates/adapters/storage-file/src/lib.rs
Proxy and cloning
- Postgres proxy
crates/applications/proxy/src/proxy.rs - Clone discovery
crates/applications/proxy/src/discovery.rs - Lazy clone extension
crates/extensions/gfs/src/route.rs - Clone catalog
crates/extensions/gfs/src/catalog.rs - Row hydration
crates/extensions/gfs/src/hydrate.rs - Copy worker
crates/extensions/gfs/src/worker.rs
Other components
- Developer or agent
Connections 21
- Developer or agent → GFS CLI: runs commands
- Developer or agent → MCP server: uses tools
- Developer or agent → Console UI: views databases
- GFS CLI → Repository operations: executes query
crates/applications/cli/src/commands/cmd_query.rs - Repository operations → Domain ports: uses abstractions
crates/domain/src/usecases/repository/execute_query_usecase.rs - Repository operations → Repository adapter: manages repository
- Repository adapter → Repository layout: delegates layout
crates/domain/src/adapters/gfs_repository.rs - Repository adapter → Commit model: records commits
crates/domain/src/adapters/gfs_repository.rs - Repository adapter → Repository config: reads config
crates/domain/src/adapters/gfs_repository.rs - Domain ports → Database providers: defines provider port
crates/domain/src/ports/database_provider.rs - Domain ports → Compute runtime: defines compute port
crates/domain/src/ports/compute.rs - GFS CLI → Database providers: selects provider
crates/applications/cli/src/commands/cmd_query.rs - GFS CLI → Compute runtime: runs query
crates/applications/cli/src/commands/cmd_query.rs - Console UI → Web console: requests API
- Web console → Clone discovery: reads clone data
- Postgres proxy → Clone discovery: runs proxy
- Lazy clone extension → Clone catalog: tracks clone state
- Lazy clone extension → Row hydration: hydrates rows
crates/extensions/gfs/src/hydrate.rs - Copy worker → Row hydration: performs queued copy
crates/extensions/gfs/src/worker.rs - Copy worker → Clone catalog: updates predicate state
crates/extensions/gfs/src/worker.rs - Repository operations → Database storage: uses storage