Faramesh Documentation

Complete documentation for the Faramesh Execution Governor platform.

Documentation Structure

Getting Started

• Quickstart.md - Quick start guide
• API.md - Complete API reference
• CLI.md - Command-line interface documentation

Execution Gate (v0.3.0)

• EXECUTION-GATE.md - Execution gate, deterministic hashing, tamper-evident audit, and decision replay

SDKs

• SDK-Python.md - Python SDK documentation
• SDK-Node.md - Node.js SDK documentation

Guides

• INTEGRATIONS.md - Framework integration guides
• LangChain integration.md - LangChain integration guide
• EXTENDING.md - Extending Faramesh guide
• HOT_RELOAD.md - Hot reload policies guide
• govern-your-own-tool.md - Guide to governing custom tools

Configuration

• Policies.md - Policy configuration guide
• POLICY_PACKS.md - Pre-built policy packs

Operations

• Docker.md - Docker deployment guide
• OBSERVABILITY.md - Metrics and monitoring
• ERROR-HANDLING.md - Error handling guide
• Troubleshooting.md - Troubleshooting guide

Security

• SECURITY-GUARDRAILS.md - Security mechanisms and guardrails

Design Partners

• DESIGN_PARTNER_GUIDE.md - Guide for design partners

Repository

Source: https://github.com/faramesh/faramesh-docs

Related Repositories

• Main Repository: https://github.com/faramesh/faramesh-core
• Python SDK: https://github.com/faramesh/faramesh-python-sdk
• Node.js SDK: https://github.com/faramesh/faramesh-node-sdk
• Web UI: https://github.com/faramesh/faramesh-ui
• Examples: https://github.com/faramesh/faramesh-examples

License

Elastic License 2.0