README
¶
|
Ghost Vault
local memory for your models |
|
Your memory, your machine — the durable record of your work lives in a layer you govern, not as a retention feature in someone else’s account. Ghost Vault is a user-held memory service: connect the same vault to Claude, ChatGPT, Gemini, Cursor, and the rest through open, swappable interfaces (OpenAPI, Model Context Protocol) so the model sees your ground truth. Switching tools should not mean starting from zero.
ghostvault.bizs.app — product overview, tutorial (including the Anthropic remote MCP), and blog
What it is: a small Go service plus Postgres (vectors + full-text), hybrid retrieval, and optional encryption at rest (ciphertext on disk until you unlock). Integrations: docs/integration/ (MCP, ChatGPT Actions, Gemini, and similar).
Run it
make setup— creates.envfrom.env.exampleif needed; set API keys andDATABASE_URLas documented there.make up— brings up Postgres, the vault API (gvsvd), an edge reverse proxy on :8989, and (by default) the MCP sidecar and dashboard. Usemaketo see all targets; details live indocs/deploy.mdanddocs/README.md.
Dashboard: after make up (dashboard profile on by default), open http://127.0.0.1:8989/dashboard/ — the edge serves /api, /mcp/, and proxies /dashboard/ to the dashboard container (internal :80). For a local Vite UI with hot reload instead, run make dashboard-dev (default :5177, set DASHBOARD_DEV_PORT if needed) and point GHOSTVAULT_BASE_URL / GHOSTVAULT_PROXY_URL at your gvsvd (see .env.example). With make up Dashboard=disable, use dashboard-dev the same way.
Without Docker: copy .env, set DATABASE_URL, go run ./cmd/gvsvd. MCP / IDE setup: docs/integration/Claude-mcp.md.
Product and threat-model depth: docs/OVERVIEW.md · openapi/openapi.yaml. Related (GitS / Ghost): ../gis/docs/design.md.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gvctl
command
Command gvctl performs common Ghost Vault HTTP calls (health, init, unlock, lock, tools) without hand-written curl.
|
Command gvctl performs common Ghost Vault HTTP calls (health, init, unlock, lock, tools) without hand-written curl. |
|
gvmcp
command
Command gvmcp is the Ghost Vault MCP server: exposes memory_search and memory_save over MCP (stdio or HTTP).
|
Command gvmcp is the Ghost Vault MCP server: exposes memory_search and memory_save over MCP (stdio or HTTP). |
|
gvsvd
command
|
|
|
internal
|
|
|
authdebug
Package authdebug formats bearer/session tokens for diagnostic logs without always printing secrets.
|
Package authdebug formats bearer/session tokens for diagnostic logs without always printing secrets. |
|
mcpbridge
Package mcpbridge registers Ghost Vault REST operations as MCP tools (memory_search, memory_save, memory_stats).
|
Package mcpbridge registers Ghost Vault REST operations as MCP tools (memory_search, memory_save, memory_stats). |