Skip to content

Nexus Documentation Index

Complete guide to Nexus documentation organized by topic.

📖 Main Guides

Document Description
Getting Started Installation and first steps
Permissions & ReBAC Complete permission system guide
Multi-Tenant Multi-tenancy implementation
Authentication Authentication and API keys
Core Tenets Design philosophy

🚀 Getting Started

Document Description
Quick Start 5-minute start guide
Installation Installation instructions
Configuration Configuration reference
Deployment Modes Embedded vs server modes

📚 API Reference

Document Description
Complete API Full API reference
Core API Core methods
File Operations File APIs
File Discovery List, glob, grep
Directory Operations Directory APIs
Permissions Permission APIs
Workspace Management Workspace APIs
Memory Management Memory APIs
Metadata Metadata operations
Mounts Backend mounts
Versioning Time travel
Semantic Search Vector search
LLM Document Reading AI-powered Q&A
Configuration Config options
Error Handling Error handling
CLI Reference CLI commands
RPC API Server API
Advanced Usage Patterns

🏗️ Architecture

Document Description
System Architecture Overall design
ReBAC Architecture Permission system internals
Tenant Isolation Multi-tenant isolation
Default Context Context design

🔐 Security

Document Description
Default Context Security Security implications

🚢 Deployment

Document Description
Server Setup Complete server setup
Deployment Guide Production deployment
PostgreSQL Setup PostgreSQL configuration
Quick Start Quick deployment
Docker Docker setup
GCP Google Cloud

💻 Development

Document Description
Development Guide Contributing
RPC Parity Embedded/server parity
Database Compatibility SQLite vs PostgreSQL
Permissions Implementation Permission internals
Permission Enforcement Enforcement details
Plugin Development Plugins
Parsers Parser development

📖 Guides

Document Description
SDK Usage Using the SDK
Delegation Permission delegation
ReBAC Roles Role patterns

🔧 Advanced Topics

Document Description
FUSE Mounting FUSE filesystem integration
SQL Patterns SQL views and patterns

🔌 Integrations

Document Description
Model Context Protocol (MCP) MCP server for AI agents (Claude Desktop, etc.)
LLM Provider LLM integration

📂 Reference

Document Description
Mount Management Mount quick reference
ReBAC Features Feature matrix

📋 Authentication & Examples

Authentication

See Authentication Guide for complete documentation.

Examples: examples/auth_demo/ - Static API key demos - Database auth demos - CLI authentication - Complete auth + permissions

Examples Directory

Location Description
examples/auth_demo/ Authentication examples
examples/parity_demo/ Parity testing
examples/py_demo/ Python SDK demos
examples/script_demo/ Shell script demos

🎯 By Use Case

"I'm getting started"

  1. Quick Start
  2. Installation
  3. Basic API

"I need permissions"

  1. Permissions Guide
  2. Permission API
  3. Try: examples/py_demo/rebac_comprehensive_demo.py

"I need multi-tenancy"

  1. Multi-Tenant Guide
  2. Try: examples/py_demo/multi_tenant_demo.py

"I need authentication"

  1. Authentication Guide
  2. Try: examples/auth_demo/

"I'm deploying to production"

  1. Server Setup
  2. PostgreSQL Setup
  3. Deployment Guide

"I'm developing features"

  1. Core Tenets
  2. Development Guide
  3. RPC Parity

"I want to integrate with AI agents"

  1. MCP Integration Guide
  2. MCP CLI Reference
  3. Agent Framework Examples:
  4. CrewAI - Multi-agent teams with memory
  5. LangGraph - ReAct agents
  6. ACE Learning - Learning from experience
  7. Claude SDK - Anthropic agents
  8. OpenAI SDK - OpenAI agents
  9. Try: examples/mcp/, examples/crewai/, examples/langgraph/

📞 Getting Help

  • GitHub Issues: https://github.com/nexi-lab/nexus/issues
  • Examples: See examples/ directory
  • Tests: See tests/integration/ for working examples

Last Updated: 2025-10-29