# Terraphim AI Assistant
[](https://crates.io/crates/terraphim_agent)
[](https://github.com/terraphim/homebrew-terraphim)
[](https://www.npmjs.com/package/@terraphim/autocomplete)
[](https://pypi.org/project/terraphim-automata/)
[](https://discord.gg/VPJXB6BGuY)
[](https://terraphim.discourse.group)
[](https://crates.io/crates/terraphim-repl)
Terraphim is a privacy-first AI assistant that works for you under your complete control and is fully deterministic.
## 🆕 v1.0.0 Minimal Release - NOW AVAILABLE!
**Quick Install** (works on Linux, macOS, Windows):
**Option 1: Universal Installer** (recommended)
```bash
# Single command installation with platform detection
# Install both agent and CLI tools
**Option 2: Homebrew** (macOS/Linux - recommended)
```bash
# Add Terraphim tap
brew tap terraphim/terraphim
# Install server
brew install terraphim-server
# Install TUI/REPL
brew install terraphim-agent
```
**Option 3: Cargo Install**
```bash
cargo install terraphim-repl # Interactive REPL (11 commands)
cargo install terraphim-cli # Automation CLI (8 commands)
```
**Features**:
- 🔍 Semantic knowledge graph search
- 🔗 Smart text linking (markdown/html/wiki)
- 💾 Offline-capable (embedded defaults)
- ⚡ Lightweight (15 MB RAM, 13 MB disk)
- 🚀 Fast (<200ms operations)
You can use it as a local search engine, configured to search for different types of content on StackOverflow, GitHub, and the local filesystem using a predefined folder, which includes your Markdown files.
Terraphim operates on local infrastructure and works exclusively for the owner's benefit.
## 🎉 v1.0.0 Major Release
We're excited to announce Terraphim AI v1.0.0 with comprehensive multi-language support:
### ✨ New Packages Available
- **🦀 Rust**: `terraphim_agent` - Complete CLI and TUI interface via crates.io
- **📦 Node.js**: `@terraphim/autocomplete` - Native npm package with autocomplete and knowledge graph
- **🐍 Python**: `terraphim-automata` - High-performance text processing library via PyPI
### 🚀 Quick Installation
**Universal Installer (Recommended)**
```bash
# Single command installation for all platforms
**Package Managers**
```bash
# Homebrew (macOS/Linux - signed & notarized binaries)
brew tap terraphim/terraphim
brew install terraphim-server # HTTP API server
brew install terraphim-agent # TUI/REPL interface
# Rust CLI (interactive TUI)
cargo install terraphim_agent
# Node.js package (autocomplete + knowledge graph)
npm install @terraphim/autocomplete
# Python library (high-performance text processing)
pip install terraphim-automata
```
https://github.com/terraphim/terraphim-ai/assets/175809/59c74652-bab4-45b2-99aa-1c0c9b90196b
## Why Terraphim?
There are growing concerns about the privacy of data and the sharing of individuals' data across an ever-growing list of services, some of which have questionable data ethics policies. <sup>[1],[2],[3],[4]</sup>
**Individuals struggle to find relevant information in different knowledge repositories:**
- Personal ones like Roam Research, Obsidian, Coda, and Notion.
- Team-focused ones like Jira, Confluence, and SharePoint.
- Public sources such as StackOverflow and GitHub.
Terraphim aims to bridge this gap by providing a privacy-first AI assistant that operates locally on the user's hardware, enabling seamless access to various knowledge repositories without compromising privacy. With Terraphim, users can efficiently search personal, team-focused, and public knowledge sources, ensuring that their data remains under their control at all times.
[1]: https://www.coveo.com/en/resources/reports/relevance-report-workplace
[2]: https://cottrillresearch.com/various-survey-statistics-workers-spend-too-much-time-searching-for-information/
[3]: https://www.forbes.com/sites/forbestechcouncil/2019/12/17/reality-check-still-spending-more-time-gathering-instead-of-analyzing/
[4]: https://www.theatlantic.com/technology/archive/2021/06/the-internet-is-a-collective-hallucination/619320/
## 🚀 Getting Started
### Option 1: Install from Package Managers (Recommended)
#### 🦀 Rust CLI/TUI (Most Features)
```bash
cargo install terraphim_agent
terraphim-agent --help
```
#### 📦 Node.js Package (Autocomplete + Knowledge Graph)
```bash
npm install @terraphim/autocomplete
# or with Bun
bun add @terraphim/autocomplete
```
#### 🐍 Python Library (Text Processing)
```bash
pip install terraphim-automata
```
### Option 2: Development Setup
1. **Clone the repository**:
```bash
git clone https://github.com/terraphim/terraphim-ai.git
cd terraphim-ai
```
2. **Set up development environment**:
```bash
./scripts/install-hooks.sh
```
3. **Start the backend server**:
```bash
cargo run
```
This starts an API endpoint for indexing and querying documents.
4. **Run the frontend** (choose one):
**Web Frontend:**
```bash
cd desktop
yarn install
yarn run dev
```
**Desktop App (Tauri):**
```bash
cd desktop
yarn install
yarn run tauri dev
```
**Terminal Interface (Agent):**
```bash
cargo build -p terraphim_agent --features repl-full --release
./target/release/terraphim-agent
cargo run -p terraphim_agent --bin terraphim-agent
```
(See the [desktop README](desktop/README.md), [TUI documentation](docs/tui-usage.md), and [development setup guide](docs/src/development-setup.md) for more details.)
## 📚 Usage Examples
### 🦀 Rust CLI/TUI
```bash
# Interactive mode with full features
terraphim-agent
# Search commands
terraphim-agent search "Rust async programming"
terraphim-agent search --role engineer "microservices"
# Chat with AI
terraphim-agent chat "Explain knowledge graphs"
# Commands list
terraphim-agent commands list
terraphim-agent commands search "Rust"
# Auto-update management
terraphim-agent check-update # Check for updates without installing
terraphim-agent update # Update to latest version if available
```
### 📦 Node.js Package
```javascript
// Import the package
import * as autocomplete from '@terraphim/autocomplete';
// Build autocomplete index from JSON thesaurus
const thesaurus = {
"name": "Engineering",
"data": {
"machine learning": {
"id": 1,
"nterm": "machine learning",
"url": "https://example.com/ml"
}
}
};
const indexBytes = autocomplete.buildAutocompleteIndexFromJson(JSON.stringify(thesaurus));
// Search for terms
const results = autocomplete.autocomplete(indexBytes, "machine", 10);
console.log('Autocomplete results:', results);
// Knowledge graph operations
const graphBytes = autocomplete.buildRoleGraphFromJson("Engineer", JSON.stringify(thesaurus));
const isConnected = autocomplete.areTermsConnected(graphBytes, "machine learning");
console.log('Terms connected:', isConnected);
```
### 🐍 Python Library
```python
import terraphim_automata as ta
# Create thesaurus
thesaurus = ta.Thesaurus(name="Engineering")
thesaurus.add_term("machine learning", url="https://example.com/ml")
thesaurus.add_term("deep learning", url="https://example.com/dl")
# Build autocomplete index
index = ta.build_autocomplete_index(thesaurus)
print(f"Index size: {len(index)} bytes")
# Search for terms
results = ta.autocomplete(index, "machine", limit=10)
for result in results:
print(f"Found: {result.term} (score: {result.score})")
# Fuzzy search
fuzzy_results = ta.fuzzy_autocomplete_search(index, "machin", min_distance=0.8)
print(f"Fuzzy results: {len(fuzzy_results)}")
```
## 🆕 v1.0.0 Features
### 🔍 Enhanced Search Capabilities
- **Grep.app Integration**: Search across 500,000+ GitHub repositories
- **Advanced Filtering**: Language, repository, and path-based filtering
- **Semantic Search**: Knowledge graph-powered semantic understanding
### 📊 Multi-Language Support
- **Rust**: Native performance with complete CLI/TUI interface
- **Node.js**: High-performance autocomplete with native bindings
- **Python**: Fast text processing and autocomplete algorithms
### 🤖 AI Integration
- **MCP Server**: Model Context Protocol for AI tool integration
- **Claude Code Hooks**: Automated development workflows
- **Knowledge Graphs**: Semantic relationship analysis and discovery
### 🔄 Auto-Update System
- **Seamless Updates**: Self-updating CLI using GitHub Releases
- **Cross-Platform**: Works on Linux, macOS, and Windows
- **Smart Versioning**: Intelligent version comparison and update detection
- **Progress Tracking**: Real-time download progress and status indicators
## Terminal Agent Interface
Terraphim includes a comprehensive terminal agent that provides both interactive REPL functionality and CLI commands for advanced operations:
### Key Features
- **🤖 AI Chat Integration**: OpenRouter and Ollama support for intelligent conversations
- **⚡ Sub-2 Second VM Boot**: Advanced VM optimization system with sub-500ms allocation
- **🖥️ Enhanced VM Management**: Firecracker microVM pools with intelligent allocation
- **📝 Markdown Command System**: Extensible commands defined in YAML frontmatter
- **🔒 Security-First Execution**: Three execution modes (Local, Firecracker, Hybrid) with knowledge graph validation
- **🌐 Web Operations**: Secure web requests through VM sandboxing
- **📁 File Operations**: Semantic file analysis and intelligent content management
- **🔍 Knowledge Graph**: Interactive rolegraph visualization and navigation
- **⚙️ Configuration**: Real-time role and configuration management
- **🔄 Auto-Update**: Seamless self-updating mechanism using GitHub Releases
### 🔄 Auto-Update System
Terraphim-agent includes a built-in auto-update system that keeps your installation current with the latest releases from GitHub.
#### Features
- **🚀 Seamless Updates**: Automatic binary replacement without manual intervention
- **📊 Progress Tracking**: Real-time download progress and status indicators
- **🔒 Secure Verification**: GitHub Releases integration ensures authenticated updates
- **🌐 Cross-Platform**: Works on Linux, macOS, and Windows
- **📋 Version Intelligence**: Smart version comparison and update availability detection
#### Usage
```bash
# Check for updates without installing
terraphim-agent check-update
# Update to latest version if available
terraphim-agent update
# Get help for update commands
terraphim-agent check-update --help
terraphim-agent update --help
```
#### Update Status Messages
- **🔍 Checking**: "🔍 Checking for terraphim-agent updates..."
- **✅ Up-to-date**: "✅ Already running latest version: X.Y.Z"
- **📦 Update Available**: "📦 Update available: X.Y.Z → A.B.C"
- **🚀 Updated**: "🚀 Updated from X.Y.Z to A.B.C"
- **❌ Failed**: "❌ Update failed: [error details]"
#### Technical Details
- **Source**: GitHub Releases from `terraphim/terraphim-ai` repository
- **Mechanism**: Rust `self_update` crate with secure binary verification
- **Architecture**: Async-safe implementation using `tokio::task::spawn_blocking`
- **Compatibility**: Requires internet connectivity for update checks
#### Example Workflow
```bash
$ terraphim-agent check-update
🔍 Checking for terraphim-agent updates...
📦 Update available: 1.0.0 → 1.0.1
$ terraphim-agent update
🚀 Updating terraphim-agent...
✅ Already running latest version: 1.0.1
```
### Quick Start
```bash
# Build with all features
cargo build -p terraphim_tui --features repl-full --release
# Launch interactive REPL
./target/release/terraphim-agent
# Available REPL commands:
/help # Show all commands
/search "query" # Semantic search
/chat "message" # AI conversation
/commands list # List available markdown commands
/deploy staging # Execute deployment (Firecracker mode)
/search "TODO" # Execute search command (Local mode)
/vm list # VM management with sub-2s boot
/web get URL # Web operations
/file search # Semantic file operations
```
For detailed documentation, see [TUI Usage Guide](docs/tui-usage.md) and [Auto-Update System](docs/autoupdate.md).
## Terminology
When configuring or working on Terraphim, you will encounter the following
terms and concepts:
- **Haystack**: A data source that Terraphim can search through. For example, this
could be a folder on your computer, a Notion workspace, or your email account.
- **Knowledge Graph**: A structured graph of information created from a
haystack, where nodes represent entities and edges represent relationships
between them.
- **Profile**: An endpoint for persisting user data (e.g. Amazon S3, sled, or
rocksdb).
- **Role**: A role is a set of settings that define the default behavior of the
AI assistant. For example, a developer role will search for code-related
content, while a "father" role might search for parenting-related content. Each
Terraphim role has its own separate knowledge graph that contains relevant
concepts, with all synonyms.
- **Rolegraph**: A structure for ingesting documents into Terraphim. It is a knowledge
graph that uses a scoring function (an Aho-Corasick automata build from the
knowledge graph) for ranking results.
## Why "Terraphim"?
The term is originally taken from the [Relict series][relict] of science fiction
novels by [Vasiliy Golovachev](https://en.wikipedia.org/wiki/Vasili_Golovachov).
Terraphim is an artificial intelligence living inside a spacesuit (part of an
exocortex), or inside your house or vehicle, and it is designed to help you with
your tasks. You can carry it around with you.
Similar entities now common in science fiction, for example Destiny 2 has entity called [Ghost][ghost].
Or in Star Wars Jedi Survivor there is an AI assistant [BD-1][bd-1].
The compactness and mobility of such AI assistant drives the [[Design Decisions]] of Terraphim.
[bd-1]: https://starwars.fandom.com/wiki/BD-1
[ghost]: https://www.destinypedia.com/Ghost
[relict]: https://www.goodreads.com/en/book/show/196710046
Terraphim is a trademark registered in the UK, US and internationally (WIPO). All other trademarks mentioned above are the property of their respective owners.
## Configuration
### Storage Backends
Terraphim supports multiple storage backends for different deployment scenarios:
#### Local Development (Default)
The system uses local storage backends by default, requiring no additional configuration:
- **Memory**: In-memory storage for testing
- **DashMap**: High-performance concurrent storage
- **SQLite**: Local database storage
- **ReDB**: Embedded key-value database
#### Cloud Storage (Optional)
For production deployments, you can optionally enable cloud storage:
##### AWS S3 Configuration
To use AWS S3 storage, set the following environment variables:
```bash
export AWS_ACCESS_KEY_ID="your-access-key"
export AWS_SECRET_ACCESS_KEY="your-secret-key"
export TERRAPHIM_PROFILE_S3_REGION="us-east-1"
export TERRAPHIM_PROFILE_S3_ENDPOINT="https://s3.amazonaws.com/"
```
**Note**: AWS credentials are completely optional. The system will automatically fall back to local storage if AWS credentials are not available, ensuring local development works without any cloud dependencies.
### Environment Variables
- `TERRAPHIM_SETTINGS_PATH`: Override the settings file path
- `TERRAPHIM_DATA_PATH`: Set the data directory location
- `LOG_LEVEL`: Set logging verbosity (debug, info, warn, error)
## Installation Methods
### For End Users
#### Homebrew (macOS/Linux)
```bash
brew install terraphim/terraphim-ai/terraphim-ai
```
This installs the server, terminal agent, and desktop app (macOS only).
#### Debian/Ubuntu
```bash
# Download from GitHub releases
sudo dpkg -i terraphim-server_*.deb
sudo dpkg -i terraphim-agent_*.deb
sudo dpkg -i terraphim-ai-desktop_*.deb
```
#### Docker
```bash
docker run ghcr.io/terraphim/terraphim-server:latest
```
#### Direct Download
Download pre-built binaries from [GitHub Releases](https://github.com/terraphim/terraphim-ai/releases).
### Development Setup
For development, see our comprehensive [Development Setup Guide](docs/src/development-setup.md) which covers:
- Code quality tools and pre-commit hooks
- Multiple installation options (no Python required!)
- IDE integration and troubleshooting
## Claude Code Integration
Terraphim provides seamless integration with Claude Code through multiple approaches, enabling intelligent text replacement and codebase quality evaluation.
### 🔄 Text Replacement (Hooks & Skills)
Use Terraphim's knowledge graph capabilities to automatically replace text patterns in your development workflow:
**Claude Code Hooks** - Automatic, transparent replacements:
```bash
# Example: Automatically replace npm with bun
```
**Claude Skills** - Context-aware, conversational assistance:
- Works across all Claude platforms
- Provides explanations and reasoning
- Progressive disclosure of functionality
**Examples:**
- Package manager enforcement (npm/yarn/pnpm → bun)
- Attribution replacement (Claude Code → Terraphim AI)
- Custom domain-specific replacements
📖 **Complete Guide**: [examples/TERRAPHIM_CLAUDE_INTEGRATION.md](examples/TERRAPHIM_CLAUDE_INTEGRATION.md)
### 📊 Codebase Quality Evaluation
Evaluate whether AI agents (Claude Code, GitHub Copilot, autonomous agents) improve or deteriorate your codebase using deterministic, knowledge graph-based assessment:
**Key Features:**
- **Deterministic**: Aho-Corasick automata for consistent scoring
- **Privacy-First**: All evaluation runs locally
- **Multi-Dimensional**: Security, performance, quality perspectives
- **CI/CD Ready**: Automated quality gates with exit codes
**Quick Start:**
```bash
cd examples/codebase-evaluation
./scripts/evaluate-ai-agent.sh /path/to/codebase
# Generates verdict:
# ✅ IMPROVEMENT: The AI agent improved the codebase quality.
# - Improved metrics: 3
# - Deteriorated metrics: 0
```
**Evaluation Metrics:**
- Clippy warnings, anti-patterns, TODO counts
- Knowledge graph density and semantic matches
- Test pass rates and code coverage
- Custom domain-specific patterns
**Use Cases:**
1. Evaluate PRs from AI agents before merge
2. Continuous quality monitoring in CI/CD pipelines
3. Historical trend analysis across evaluations
4. Multi-role evaluation (security + performance + quality)
📖 **Complete Documentation**: [examples/codebase-evaluation/](examples/codebase-evaluation/)
**Example GitHub Actions Integration:**
```yaml
- name: Baseline evaluation
run: ./scripts/baseline-evaluation.sh ${{ github.workspace }}
- name: Apply AI changes
run: # Your AI agent step
- name: Post-change evaluation
run: ./scripts/post-evaluation.sh ${{ github.workspace }}
- name: Generate verdict (fails on deterioration)
run: ./scripts/compare-evaluations.sh
```
## Contributing
We welcome contributions! Here's how to get started:
1. **Read our guides**:
- [Contributing guide](CONTRIBUTING.md)
- [Development setup](docs/src/development-setup.md)
2. **Set up your environment**:
```bash
git clone https://github.com/terraphim/terraphim-ai.git
cd terraphim-ai
./scripts/install-hooks.sh # Sets up code quality tools
```
3. **Code quality standards**:
- All commits must follow [Conventional Commits](https://www.conventionalcommits.org/)
- Rust code is automatically formatted with `cargo fmt`
- JavaScript/TypeScript uses [Biome](https://biomejs.dev/) for linting and formatting
- No secrets or large files allowed in commits
4. **Make your changes**:
- Create a feature branch: `git checkout -b feat/your-feature`
- Make your changes with proper tests
- Commit with conventional format: `git commit -m "feat: add amazing feature"`
- Push and create a Pull Request
### Dependency Management
**Important**: Some dependencies are pinned to specific versions to ensure compatibility:
- `wiremock = "0.6.4"` - Version 0.6.5 uses unstable Rust features requiring nightly compiler
- `schemars = "0.8.22"` - Version 1.0+ introduces breaking API changes
- `thiserror = "1.0.x"` - Version 2.0+ requires code migration for breaking changes
These constraints are enforced in `.github/dependabot.yml` to prevent automatic updates that would break CI. Future upgrades require manual code migration work.
### Contributors are awesome
<a href="https://github.com/terraphim/terraphim-ai/graphs/contributors">
<img src="https://contrib.rocks/image?repo=terraphim/terraphim-ai" />
</a>
## License
This project is licensed under the [Apache license](LICENSE).