Revise README for clarity and API key details

Updated various sections for clarity and added information about API key requirements.
This commit is contained in:
Jack Colquitt 2026-03-11 13:50:32 -07:00 committed by GitHub
parent b9d7bf9a8b
commit d464d552e9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -7,19 +7,15 @@
[![Discord](https://img.shields.io/discord/1251652173201149994 [![Discord](https://img.shields.io/discord/1251652173201149994
)](https://discord.gg/sQMwkRz5GX) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/trustgraph-ai/trustgraph) )](https://discord.gg/sQMwkRz5GX) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/trustgraph-ai/trustgraph)
[**Website**](https://trustgraph.ai) | [**Docs**](https://docs.trustgraph.ai) | [**YouTube**](https://www.youtube.com/@TrustGraphAI?sub_confirmation=1) | [**Configuration Builder**](https://config-ui.demo.trustgraph.ai/) | [**Discord**](https://discord.gg/sQMwkRz5GX) | [**Blog**](https://blog.trustgraph.ai/subscribe) [**Website**](https://trustgraph.ai) | [**Docs**](https://docs.trustgraph.ai) | [**YouTube**](https://www.youtube.com/@TrustGraphAI?sub_confirmation=1) | [**Configuration Terminal**](https://config-ui.demo.trustgraph.ai/) | [**Discord**](https://discord.gg/sQMwkRz5GX) | [**Blog**](https://blog.trustgraph.ai/subscribe)
<a href="https://trendshift.io/repositories/17291" target="_blank"><img src="https://trendshift.io/api/badge/repositories/17291" alt="trustgraph-ai%2Ftrustgraph | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> <a href="https://trendshift.io/repositories/17291" target="_blank"><img src="https://trendshift.io/api/badge/repositories/17291" alt="trustgraph-ai%2Ftrustgraph | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
# The context backend for AI agents # The context backend for reliable AI
</div> </div>
Durable agent memory you can trust. Build, version, and retrieve grounded context from a context graph. LLMs alone hallucinate and diverge from ground truth. TrustGraph is a context system that stores, enriches, and delivers context to LLMs to enable reliable AI agents. Think like [Supabase](https://github.com/supabase/supabase) but AI-native with context graph enrichment.
- Give agents **memory** that persists across sessions and deployments.
- Reduce hallucinations with **grounded context retrieval**
- Ship reusable, portable [Context Cores](#context-cores) (packaged context you can move between projects/environments).
The context backend: The context backend:
- [x] Multi-model and multimodal database system - [x] Multi-model and multimodal database system
@ -49,6 +45,21 @@ The context backend:
- [x] Websocket API [Docs](https://docs.trustgraph.ai/reference/apis/websocket.html) - [x] Websocket API [Docs](https://docs.trustgraph.ai/reference/apis/websocket.html)
- [x] Python API [Docs](https://docs.trustgraph.ai/reference/apis/python) - [x] Python API [Docs](https://docs.trustgraph.ai/reference/apis/python)
- [x] CLI [Docs](https://docs.trustgraph.ai/reference/cli/) - [x] CLI [Docs](https://docs.trustgraph.ai/reference/cli/)
## No API Keys Required
How many times have you cloned a repo and opened the `.env.example` to see the dozens of API keys for 3rd party dependencies needed to make the services work? There are only 3 things in TrustGraph that might need an API key:
- 3rd party LLM services like Anthropic, Cohere, Gemini, Mistral, OpenAI, etc.
- 3rd party OCR like Mistral OCR
- The API key *you set* for the TrustGraph API gateway
Everything else is included.
- [x] Managed Multi-model storage in [Cassandra](https://cassandra.apache.org/_/index.html)
- [x] Managed Vector embedding storage in [Qdrant](https://github.com/qdrant/qdrant)
- [x] Managed File and Object storage in [Garage](https://github.com/deuxfleurs-org/garage) (S3 compatible)
- [x] Managed High-speed Pub/Sub messaging fabric with [Pulsar](https://github.com/apache/pulsar)
- [x] Complete LLM inferencing stack for open LLMs with [vLLM](https://github.com/vllm-project/vllm), [TGI](https://github.com/huggingface/text-generation-inference), [Ollama](https://github.com/ollama/ollama), [LM Studio](https://github.com/lmstudio-ai), and [Llamafiles](https://github.com/mozilla-ai/llamafile)
## Quickstart ## Quickstart
@ -65,6 +76,8 @@ TrustGraph downloads as Docker containers and can be run locally with Docker, Po
width="80%" controls></video> width="80%" controls></video>
</p> </p>
For a browser based quickstart, try the [Configuration Terminal](https://config-ui.demo.trustgraph.ai/).
<details> <details>
<summary>Table of Contents</summary> <summary>Table of Contents</summary>
<br> <br>
@ -168,30 +181,24 @@ TrustGraph provides component flexibility to optimize agent workflows.
</details> </details>
<details> <details>
<summary>Graph Storage</summary> <summary>Multi-model storage</summary>
<br> <br>
- Apache Cassandra (default)<br> - Apache Cassandra<br>
- Neo4j<br>
- Memgraph<br>
- FalkorDB<br>
</details> </details>
<details> <details>
<summary>VectorDBs</summary> <summary>VectorDB</summary>
<br> <br>
- Qdrant (default)<br> - Qdrant<br>
- Pinecone<br>
- Milvus<br>
</details> </details>
<details> <details>
<summary>File and Object Storage</summary> <summary>File and Object Storage</summary>
<br> <br>
- Garage (default)<br> - Garage<br>
- MinIO<br>
</details> </details>
<details> <details>
@ -200,6 +207,7 @@ TrustGraph provides component flexibility to optimize agent workflows.
- Prometheus<br> - Prometheus<br>
- Grafana<br> - Grafana<br>
- Loki<br>
</details> </details>
<details> <details>