Getting Started

January 6, 2026 ยท View on GitHub

Get IntellyWeave CLI running in under 5 minutes.

What It Does

IntellyWeave CLI is an enterprise command-line tool for:

  • Managing Weaviate vector database operations
  • OSINT intelligence analysis workflows
  • Data import/export with safety controls
  • MCP (Model Context Protocol) integration for AI-driven queries

Prerequisites

Before you begin, ensure you have:

RequirementVersionNotes
Node.js>= 18Required
npm>= 9Comes with Node.js
WeaviateAnyLocal Docker or Weaviate Cloud
VoyageAI API Key-Optional, for embeddings
Anthropic API Key-Optional, for AI shell features

Quick Installation

# Install globally
npm install -g intellyweave-cli

# Or use with npx (no installation required)
npx intellyweave-cli --help

After installation, the CLI is available via the intellyweave command.

5-Minute Setup

1. Create Environment File

# In your project directory
cp .env.example .env

2. Configure Weaviate Connection

Edit .env with your Weaviate settings:

# For local Weaviate (Docker)
WEAVIATE_URL=http://localhost:8080

# OR for Weaviate Cloud
# WCD_URL=https://your-cluster.weaviate.network
# WCD_API_KEY=your-api-key

3. Verify Configuration

intellyweave config show

4. Check Weaviate Connection

intellyweave setup

This will:

  • Validate environment variables
  • Test Weaviate connection
  • List available collections

5. Start Using the CLI

# List collections
intellyweave weaviate collections

# Start interactive shell
intellyweave shell

What's Next?

GoalGuide
Learn all commandsCLI Commands Reference
Understand mutation safetyMutation Safety Guide
Use the interactive shellInteractive Shell Guide
Set up MCP integrationMCP Integration Guide

Troubleshooting

"Not connected to Weaviate"

Ensure Weaviate is running and accessible:

# Check if Weaviate is running locally
docker ps | grep weaviate

# Start Weaviate with Docker Compose
docker compose up -d weaviate

"Environment configuration validation failed"

Check your .env file:

  • WEAVIATE_URL or WCD_URL should be set correctly
  • For Weaviate Cloud, ensure WCD_API_KEY is set

Connection timeout or network errors

  • Verify Weaviate URL is correct
  • Check network connectivity
  • Try with --verbose flag for detailed error logs:
intellyweave --verbose weaviate status

See Also