NarraNexus

https://narra.nexus/docs
Admin
NarraNexus is an open-source multi-agent platform that gives AI agents long-term narrative memory,...
Tokens:16,685
Snippets:257
Trust Score:4.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Clone and run NarraNexus locally

Source: https://narra.nexus/docs/getting-started/quick-start

Clones the NarraNexus repository and runs the setup script. The script checks for uv, node, and tmux, prints install instructions if any are missing, then installs dependencies and launches a tmux session with all ten services.

```bash
git clone https://github.com/NetMindAI-Open/NarraNexus.git
cd NarraNexus
bash run.sh
```

--------------------------------

### Install frontend dependencies with npm

Source: https://narra.nexus/docs/contributing/development-setup

Installs the frontend Node.js dependencies from the frontend directory.

```bash
cd frontend && npm install
```

--------------------------------

### Copy environment file

Source: https://narra.nexus/docs/contributing/development-setup

Copies the example environment file to .env for local configuration.

```bash
cp .env.example .env
```

--------------------------------

### SKILL.md file format with YAML frontmatter and Markdown body

Source: https://narra.nexus/docs/tools/create-a-skill

The complete SKILL.md file format with YAML frontmatter for metadata and a Markdown body for instructions. Use this as the template when creating a skill; the frontmatter declares required environment variables and binary dependencies, while the body guides the agent through setup, usage, and API reference.

```markdown
---
name: "my-skill"
description: "What this skill does in one sentence"
version: "1.0.0"
author: "Your Name"
metadata:
  clawdbot:
    requires:
      env: ["API_KEY", "API_SECRET"]
      bins: ["python", "curl"]
---

# My Skill

## What It Does
Describe the capability this skill provides...

## Setup
1. Go to https://example.com and create an account
2. Generate an API key from the settings page
3. Save the key (the agent will store it automatically)

## Usage
Explain how to use the skill in conversation...

## API Reference
Document the endpoints or commands the agent will use...
```

--------------------------------

### Install backend dependencies with pip

Source: https://narra.nexus/docs/contributing/development-setup

Installs the backend Python dependencies in editable mode with development extras.

```bash
pip install -e ".[dev]"
```

--------------------------------

### Run quality checks with Make

Source: https://narra.nexus/docs/contributing/development-setup

Make targets for linting, type checking, testing, and database schema sync.

```bash
make lint
```

```bash
make typecheck
```

```bash
make test
```

```bash
make db-sync-dry
```

```bash
make db-sync
```

--------------------------------

### Run development services with Make

Source: https://narra.nexus/docs/contributing/development-setup

Four Make targets to run the backend, MCP servers, poller, and frontend in parallel, each in its own terminal.

```bash
make dev-backend
```

```bash
make dev-mcp
```

```bash
make dev-poller
```

```bash
make dev-frontend
```

--------------------------------

### Project structure tree

Source: https://narra.nexus/docs/contributing/development-setup

Shows the directory layout of the NarraNexus project, highlighting key backend and frontend directories.

```text
NarraNexus/
├── backend/              # FastAPI routes
├── frontend/             # React + Vite
├── src/xyz_agent_context/
│   ├── agent_runtime/    # 7-step pipeline
│   ├── context_runtime/  # Context assembly
│   ├── narrative/        # Narrative system
│   ├── module/           # All modules
│   ├── schema/           # Pydantic models
│   ├── repository/       # Data access layer
│   ├── services/         # Background services
│   └── utils/            # Shared utilities
└── .mindflow/            # Documentation system
```

--------------------------------

### Clone the NarraNexus repository

Source: https://narra.nexus/docs/contributing/development-setup

Clones the NarraNexus repository and changes into the project directory.

```bash
git clone https://github.com/NetMindAI-Open/NarraNexus.git && cd NarraNexus
```
Tokens:
Raw