Getting Started with Terraphim AI

Welcome to Terraphim AI! This guide will help you get up and running quickly, whether you're a developer, researcher, or end user.

🚀 Quick Start (5 Minutes)

Choose Your Installation Method

Option 1: Rust CLI/TUI (Recommended for Power Users)

cargo install terraphim-agent
terraphim-agent --help

Option 2: Node.js Package (Great for Web Integration)

npm install @terraphim/autocomplete
# or with Bun
bun add @terraphim/autocomplete

Option 3: Python Library (Perfect for Data Processing)

pip install terraphim-automata

Option 4: Desktop Application (GUI Users)

Download from GitHub Releases

Your First Query

After installation, try your first semantic search:

# Rust CLI
terraphim-agent search "your query here"

# Node.js
const terraphim = require('@terraphim/autocomplete');
const results = await terraphim.search('your query here');

# Python
from terraphim_automata import Autocomplete
engine = Autocomplete()
results = engine.search('your query here')

🎯 What Can Terraphim AI Do?

Core Capabilities

• 🔍 Semantic Search: Find information across multiple data sources
• 🧠 Knowledge Graph: Understand relationships between concepts
• 💬 AI Chat: Interactive conversations with your data
• 📊 Smart Linking: Automatic markdown/html/wiki linking
• 🔄 Auto-Update: Always up-to-date with latest features

Data Sources You Can Search

• Local Files: Your markdown, text, and code files
• GitHub Repositories: Search across 500,000+ public repositories
• Team Knowledge: Jira, Confluence, SharePoint integration
• Stack Overflow: Programming questions and answers

🏗️ Architecture Overview

Terraphim AI uses a modular, privacy-first architecture:

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   Rust Core     │    │   Node.js Bindings│    │  Python Bindings │
│   (terraphim_   │    │  (@terraphim/     │    │ (terraphim-      │
│    service)      │    │   autocomplete)    │    │   automata)      │
└─────────┬───────┘    └─────────┬─────────┘    └─────────┬─────────┘
          │                        │                        │
          └─────────────────────────┴────────────────────┘
                    ┌─────────────────────────┐
                    │  Knowledge Graph       │
                    │  (terraphim_rolegraph) │
                    │  (terraphim_automata)   │
                    └─────────────────────────┘

🔧 Configuration Basics

Environment Setup

1. Basic Configuration

Create a configuration file at ~/.config/terraphim/config.toml:

[data]
default_data_path = "~/Documents/terraphim"
index_documents = true

[search]
default_scorer = "tfidf"  # Options: bm25, tfidf, jaccard
max_results = 20

[llm]
provider = "ollama"  # Options: ollama, openrouter, claude
model = "llama3.2:3b"
temperature = 0.7

2. Data Source Configuration

Add your data sources:

[sources.local_files]
path = "~/Documents"
file_types = ["md", "txt", "rst"]

[sources.github]
enabled = true
languages = ["rust", "python", "javascript"]

📚 Next Steps

For Different User Types

🔬 Researchers & Data Scientists

• Data Processing Guide
• Advanced Search Techniques
• API Reference

🌐 Web Developers

• Node.js Integration
• REST API Guide
• Browser Extension Setup

👥‍💼 Business Users

• Team Deployment Guide
• Configuration Management
• Troubleshooting

🔧 System Administrators

• Server Installation
• Desktop Deployment
• Security Configuration

❓ Need Help?

Common Questions

Q: Which package should I use? A:

• Developers: Rust CLI (terraphim-agent)
• Web Integration: Node.js (@terraphim/autocomplete)
• Data Analysis: Python (terraphim-automata)
• GUI Users: Desktop application

Q: How do I add my own data? A: See Configuration Guide for detailed instructions

Q: Can I use Terraphim offline? A: Yes! Terraphim is privacy-first and works completely offline with embedded defaults

Getting Support

• 📚 Documentation: Full Documentation
• 💬 Discord: Join our Community
• 🏛️ Discourse: Discussion Forum
• 🐛 Issues: Report on GitHub

🎉 You're Ready!

You now have Terraphim AI installed and configured. Start exploring your knowledge graph with semantic search powered by AI assistance.

Try these commands first:

terraphim-agent search "semantic search examples"
terraphim-agent chat "help me understand my data"
terraphim-agent role create research-assistant

Welcome to the future of privacy-first AI assistance! 🚀

Last Updated: December 20, 2025 Part of: Terraphim AI Documentation v1.3.0