Deep-dive docs for Faramesh Core — the open-source execution gatekeeper for AI agents.
For the hosted version, see faramesh.dev.
| File | What's in it |
|---|---|
| Quickstart.md | Install, run, first action |
| INTEGRATIONS.md | LangChain, CrewAI, AutoGen, MCP, LangGraph, LlamaIndex |
| govern-your-own-tool.md | Wrap any custom tool |
| LangChain integration.md | LangChain deep-dive |
| HOT_RELOAD.md | Hot-reload policies without restart |
| EXTENDING.md | Extending Faramesh |
| File | What's in it |
|---|---|
| API.md | Full HTTP API reference |
| CLI.md | All CLI commands |
| EXECUTION-GATE.md | How the gate works, deterministic hashing, audit chain |
| Policies.md | Policy syntax, rules, first-match-wins |
| POLICY_PACKS.md | Ready-to-use policy templates |
| File | What's in it |
|---|---|
| SDK-Python.md | Python SDK (faramesh-sdk) |
| SDK-Node.md | Node.js SDK (@faramesh/sdk) |
| File | What's in it |
|---|---|
| Docker.md | Docker Compose setup |
| OBSERVABILITY.md | Prometheus metrics, monitoring |
| UI.md | Dashboard and web UI |
| File | What's in it |
|---|---|
| SECURITY-GUARDRAILS.md | Security model |
| ERROR-HANDLING.md | Error types and handling |
| Troubleshooting.md | Common issues |
| Repo | Purpose |
|---|---|
| faramesh-core | The server + policy engine |
| faramesh-examples | Runnable examples |
| faramesh-python-sdk | Python SDK |
| faramesh-node-sdk | Node.js SDK |