Getting Started

Get Nodus running in 5 minutes and experience your first AI-powered morning brief.

Prerequisites

Before installing Nodus, ensure you have:

Python 3.10 or higher
4GB RAM (8GB recommended)
2GB free disk space
Claude Code or API key (optional but recommended)

Installation

Option 1: Quick Install (Recommended)

# Clone and setup
git clone https://github.com/faramarz/nodus.git
cd nodus
 
# Create virtual environment
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
 
# Install dependencies
pip install -r requirements.txt
 
# Initialize Nodus
python -m nodus init

Option 2: pip Install (Coming Soon)

pip install nodus
nodus init

Option 3: Docker

docker pull faramarz/nodus:latest
docker run -it -v ~/nodus-vault:/vault faramarz/nodus init

First-Time Setup

Initialize Your Vault

The vault is where Nodus stores your knowledge graph:

nodus init
 
# This will:
# - Create ~/.nodus directory
# - Initialize the knowledge vault
# - Set up configuration files
# - Create morning dashboard templates

Import Your Knowledge

Import your existing documents, notes, and meeting transcripts:

# Import from multiple sources
nodus import --source ~/Documents --source ~/Notes --source ~/Meetings
 
# Import specific file types
nodus import --source ~/Work --pattern "*.md" --pattern "*.txt"
 
# Import with metadata extraction
nodus import --source ~/Projects --extract-metadata

Connect Integrations

Connect your calendar, email, and chat tools:

# Connect Google Calendar
nodus connect calendar --provider google
 
# Connect Slack
nodus connect chat --provider slack
 
# Connect Email
nodus connect email --provider gmail

Configure AI Models

Set up your preferred AI model:

# Use Claude (recommended)
nodus config set model.default claude-3-opus
 
# Use GPT-4
nodus config set model.default gpt-4
 
# Use local model
nodus config set model.default llama2-local

Your First Morning Brief

Now you're ready to experience the magic:

nodus morning

This will:

Process your calendar for today
Analyze recent meetings and emails
Search your knowledge vault for relevant context
Generate prioritized action items
Prepare briefing documents for key meetings

What You'll See

$ nodus morning
 
🔄 Processing calendar events...
🔄 Analyzing meeting transcripts...
🔄 Searching knowledge vault (630K chunks)...
🔄 Coordinating 12 agents...
 
Good morning, [Your Name]
 
📅 Today's Schedule (3 key events)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
10:00 AM - Product Review with Sarah
  → Briefing prepared: 3 discussion points, 2 decisions needed
  → Related context: Last week's action items (2/3 complete)
 
2:00 PM - Customer Success Sync
  → Risk alert: Client ABC usage down 40%
  → Recommendation: Proactive outreach with solution proposal
 
4:00 PM - Engineering Standup
  → Blocker identified: Database migration decision needed
  → Context loaded: Architecture pros/cons analysis ready
 
🎯 Top 3 Priorities
━━━━━━━━━━━━━━━━━
1. ⚠️ Address Client ABC churn risk (draft prepared)
2. 📊 Review Q4 metrics before Sarah meeting
3. 🔧 Unblock engineering on migration path
 
📝 Prepared Documents
━━━━━━━━━━━━━━━━━━━
• product-review-brief.md
• client-abc-recovery-plan.md
• migration-decision-matrix.md
 
✨ 847 signals processed | 12 agents coordinated | 4.2s total

Daily Workflow

Morning Routine

# Start your day with intelligence
nodus morning
 
# Get specific meeting prep
nodus prep "meeting with Sarah"
 
# Quick priority check
nodus priorities

Throughout the Day

# Search your knowledge
nodus search "client requirements for Project X"
 
# Add notes to vault
nodus capture "Met with John - discussed pricing model changes"
 
# Get context for decisions
nodus context "database migration options"

End of Day

# Capture today's learnings
nodus reflect
 
# Prepare for tomorrow
nodus tomorrow
 
# Update project status
nodus update project-x "Completed phase 1"

Next Steps

Understand how Nodus works under the hood
Customize Nodus for your workflow
Master the semantic search system
See how others use Nodus

Troubleshooting

Common Issues

Import is taking too long

Large document collections can take time to vectorize. You can:

Import in batches: nodus import --batch-size 100
Use incremental import: nodus import --incremental
Check progress: nodus status import

Morning brief is empty

Make sure you have:

Connected your calendar: nodus connect calendar
Imported knowledge: nodus import --source ~/Documents
Configured time zone: nodus config set timezone "America/New_York"

AI model not responding

Check your API configuration:

# Verify API key
nodus config get model.api_key
 
# Test connection
nodus test connection
 
# Use fallback model
nodus config set model.fallback gpt-3.5-turbo

Get Help

Pro Tip: Run nodus morning --verbose to see exactly what Nodus is processing. This helps you understand how it synthesizes intelligence from your data.