Skip to content

Getting Started with Nexus

Welcome to Nexus! This guide will help you get up and running in minutes.

Installation

Learn how to install Nexus via pip and set up your environment.

Install Nexus →

Quick Start

Get started with a working example in under 5 minutes.

Quick Start →

Configuration

Configure Nexus for your specific use case.

Configure →

Deployment

Deploy in embedded, server, or distributed mode.

Deploy →


What is Nexus?

Nexus is an AI-native distributed filesystem designed from the ground up for production AI agents. It provides:

  • Context Preservation: Never lose agent context across restarts
  • Enterprise Security: Google Zanzibar-style ReBAC permissions
  • Multi-Tenancy: Native tenant isolation for SaaS applications
  • Time Travel: Built-in versioning and point-in-time recovery
  • Semantic Search: AI-first search capabilities
  • Distributed First: Seamless embedded-to-cloud deployment

Quick Example

import nexus

# Connect to Nexus
nx = nexus.connect(config={"data_dir": "./nexus-data"})

# Write a file
nx.write("/hello.txt", b"Hello, Nexus!")

# Read it back
content = nx.read("/hello.txt")
print(content.decode())  # "Hello, Nexus!"

# List files
files = nx.list("/")

Choose Your Path


Need Help?