IntellyWeave CLI

Operations backbone for IntellyWeave—the open-source platform for OSINT analysis, archival research, and investigative journalism. Manage Weaviate databases, migrate data, and query with AI.

---

Quick Start | Documentation | Interactive Shell | Contributing

---

See It In Action

Start the interactive shell and query your data with natural language:

intellyweave shell

> Please add the archive vault.fbi.gov and save it

Researching vault.fbi.gov...
FBI Records: The Vault - 6,700+ declassified documents
✓ Saved to: ./data/archive_domains_update.yaml

> Ask weaviate who was Paul Stangl and what evidences about his exfiltration to Brazil exist

Searching Weaviate collections...

Paul Stangl was an Austrian Nazi war criminal.

Evidence found:
1. Brazilian Consular Qualification Card (1952)
   - Issued: Beirut, Lebanon → Permanent admission to Brazil
2. Part of "Rattenlinie" (Rat Lines) network
   - Vatican officials facilitated escape

> /collections

{
  "collections": ["ELYSIA_CHUNKED_...", "ELYSIA_METADATA__", ...],
  "total": 7
}

More examples in the Interactive Shell Guide

---

What is IntellyWeave CLI?

IntellyWeave CLI is the operations backbone for the IntellyWeave platform—an open-source tool for OSINT analysis, historical research, and investigative journalism. It provides direct access to Weaviate vector database operations, data migration tools, and an AI-powered shell for natural language queries.

Manage your data. Automate your workflows. Query with AI.

Who Should Use This?

IntellyWeave CLI is for teams who need to:

• Database Administrators — Manage Weaviate collections, objects, and schemas without the web UI
• DevOps Engineers — Automate backup/restore operations in CI/CD pipelines
• Power Users — Script bulk operations and explore data programmatically
• Developers — Debug and explore IntellyWeave data with AI assistance
• Archive Researchers — Configure new archive sources for the Quartermaster agent

Key Features

Weaviate Database Management

Direct access to all Weaviate operations from the command line.

# List all collections with statistics
intellyweave weaviate collections --verbose

# Hybrid search across document chunks
intellyweave weaviate search ELYSIA_CHUNKED "Vatican escape routes"

# Browse objects with pagination
intellyweave weaviate objects ELYSIA_UPLOADED_DOCUMENTS --limit 20

Command	Description
weaviate status	Check connection health
weaviate collections	List all collections
weaviate stats	Show database statistics
weaviate search	Hybrid keyword + vector search
weaviate objects	Browse collection objects
weaviate delete	Delete collections (requires --live)

Weaviate Operations Guide

Data Import/Export

Backup, restore, and migrate Weaviate data with JSON files.

# Export all collections to backup directory
intellyweave data export --output-dir ./backup-2026-01-06

# Preview import (dry-run by default)
intellyweave data import --input-dir ./backup

# Execute import with --live flag
intellyweave --live data import --input-dir ./backup

Operation	Dry-Run	Live
Export	Read-only (always safe)	N/A
Import	Shows preview	--live required
Delete	Shows what would be deleted	--live required

Data Operations Guide

Mutation Safety

Safe by default. All data-modifying operations require explicit --live flag.

# Preview what would happen (no changes made)
intellyweave data import
# Output: [DRY RUN] Would import 150 objects to ELYSIA_CHUNKED...

# Execute the mutation
intellyweave --live data import
# Output: Imported 150 objects to ELYSIA_CHUNKED

This prevents accidental data loss and enables safe exploration of commands before execution.

Mutation Safety Guide

Interactive Shell with AI Agent

Natural language queries powered by Claude. Ask questions, get answers.

intellyweave shell

IntellyWeave v1.0.0

Type :help for commands, or ask a question.

intellyweave> How many documents are in Weaviate?

Checking collection statistics...
You have 1,234 documents across 5 collections.

intellyweave> Search for entities related to Vatican

Found 12 entities mentioning "Vatican":
1. Organization: "Vatican Secretariat" (confidence: 0.95)
2. Location: "Vatican City" (confidence: 0.92)
...

Shell Features:

Feature	Description
Natural Language	Ask questions in plain English
Quick Commands	/collections, /stats, /config
File Citations	@filename.md for AI context
MCP Integration	Connect to AI tool servers
Command History	Persistent across sessions
Mode Toggles	/live, /json, /verbose

Interactive Shell Guide

MCP Integration

Connect to Model Context Protocol servers for AI-driven operations. IntellyWeave CLI uses three MCP servers:

Server	Purpose
mcp-weaviate	11 tools for Weaviate database operations
Perplexity MCP	Web research and AI-powered search
Filesystem MCP	Code editing and codebase search

# Setup: Clone and configure the custom Weaviate MCP server
git clone https://github.com/vericle/mcp-weaviate.git

# See setup guide for complete instructions

# Verify MCP connections
intellyweave shell

# Expected output:
# Loaded MCP servers: filesystem, perplexity, weaviate
# 17 tools total

Weaviate MCP Setup Guide | MCP Integration Guide

Archive Configuration

Configure archive sources for the IntellyWeave Quartermaster agent.

# Research and add a new archive source
intellyweave archive config add https://bundesarchiv.de

# Output: Researching archive via Perplexity...
# Output: Generated YAML appended to ./data/archive_domains_update.yaml

This generates properly formatted YAML for the platform's archive_domains.yaml configuration.

---

Quick Start

Installation

# Install globally
npm install -g intellyweave-cli

# Or use with npx
npx intellyweave-cli --help

Configuration

1. Environment variables — Copy .env.example to .env:

cp .env.example .env

Edit with your API keys. See Environment Variables Reference for all options.

2. MCP servers — Copy intellyweave.config.example.json to intellyweave.config.json:

cp intellyweave.config.example.json intellyweave.config.json

For Weaviate MCP, clone mcp-weaviate and follow the Weaviate MCP Setup Guide.

First Commands

# 1. Verify configuration
intellyweave config show

# 2. Check Weaviate connection
intellyweave setup

# 3. List collections
intellyweave weaviate collections

# 4. Start interactive shell
intellyweave shell

Getting Started Guide

---

Documentation

Getting Started

Guide	Description
Installation	Setup and configuration
Quick Start	First steps with the CLI

Feature Guides

Guide	Description
Interactive Shell	AI-powered shell with quick commands
Mutation Safety	Safe-by-default operation model
Weaviate MCP Setup	Configure custom Weaviate MCP server
MCP Integration	Model Context Protocol setup
Weaviate Operations	Database management
Data Operations	Import, export, migration

Reference

Document	Description
CLI Commands	Complete command reference
Global Options	Flags available on all commands
Environment Variables	Configuration options
Architecture	System design

Contributing

Document	Description
Development Setup	Local development
Code Standards	TypeScript patterns
Testing	Test framework and philosophy
Publishing	npm release process

---

Command Reference

Global Options

Flag	Description
--live	Enable mutations (required for data changes)
--json	Output in JSON format
--quiet	Suppress info-level output
--verbose	Enable debug logging
--no-banner	Hide startup banner

Common Commands

# Configuration
intellyweave setup                    # Run setup wizard
intellyweave config show              # Display configuration

# Weaviate Operations
intellyweave weaviate status          # Check connection
intellyweave weaviate collections     # List collections
intellyweave weaviate stats           # Show statistics
intellyweave weaviate search <col> "query"  # Hybrid search

# Data Operations
intellyweave data export              # Export to JSON
intellyweave --live data import       # Import from JSON
intellyweave --live data delete       # Delete collections

# Interactive
intellyweave shell                    # Start AI shell
intellyweave mcp --check              # Verify MCP servers

Full Command Reference

---

Technical Stack

Component	Technology
Language	TypeScript 5.7+ (ESM)
CLI Framework	Commander.js 12.x
Database Client	weaviate-client 3.x
AI Integration	Vercel AI SDK + Anthropic Claude
MCP Protocol	@modelcontextprotocol/sdk 1.x
Linting	Biome 2.x
Testing	AVA 6.x + c8 coverage

---

Relationship to IntellyWeave Platform

IntellyWeave CLI is the management layer for the IntellyWeave OSINT platform:

┌─────────────────────────────────────────────────────────────┐
│              IntellyWeave Platform (Web UI)                  │
│  Entity Extraction • Geospatial Maps • Network Analysis      │
│  Archive Research • Courthouse Debate • Intelligence Agent   │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                    Weaviate Vector DB                        │
│  ELYSIA_UPLOADED_DOCUMENTS • ELYSIA_CHUNKED_* • Metadata     │
└─────────────────────────────────────────────────────────────┘
                              ▲
                              │
┌─────────────────────────────────────────────────────────────┐
│              IntellyWeave CLI (This Tool)                    │
│  Database Ops • Data Migration • MCP Tools • AI Shell        │
└─────────────────────────────────────────────────────────────┘

Platform Feature	CLI Support
Document collections	weaviate collections, weaviate objects
Entity metadata	weaviate search (hybrid search)
Data backup	data export
Data migration	data export → data import
Archive sources	archive config add
AI queries	Interactive shell with Claude

---

Support

• Issues: GitHub Issues
• Documentation: docs/
• Platform: IntellyWeave

Contributing

We welcome contributions! See the Contributing Guide for development setup, code standards, and testing.

For AI coding assistants, see AGENTS.md for comprehensive technical documentation.

---

License

MIT License — See LICENSE for details.

---

IntellyWeave CLI — Operations backbone for intelligence analysis.