Skip to content

installation.md

Latest commit

 

History

History
181 lines (128 loc) · 3.24 KB

installation.md

File metadata and controls

181 lines (128 loc) · 3.24 KB

Installation

Detailed installation options for IntellyWeave CLI.

Installation Methods

Global Installation (Recommended)

Install the package globally for system-wide access:

npm install -g intellyweave-cli

After installation, run commands directly:

intellyweave --help
intellyweave weaviate status

npx (No Installation)

Run without installing:

npx intellyweave-cli --help
npx intellyweave-cli weaviate collections

Local Project Installation

Install as a project dependency:

npm install intellyweave-cli

Run via npx or npm scripts:

npx intellyweave --help

Or add to package.json scripts:

{
  "scripts": {
    "db": "intellyweave"
  }
}

Weaviate Setup

IntellyWeave CLI requires a Weaviate instance. Choose one:

Option 1: Local Weaviate (Docker)

Create a docker-compose.yaml:

version: '3.8'
services:
  weaviate:
    image: semitechnologies/weaviate:latest
    ports:
      - "8080:8080"
      - "50051:50051"
    environment:
      QUERY_DEFAULTS_LIMIT: 25
      AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
      PERSISTENCE_DATA_PATH: '/var/lib/weaviate'
    volumes:
      - weaviate_data:/var/lib/weaviate

volumes:
  weaviate_data:

Start Weaviate:

docker compose up -d weaviate

Configure .env:

WEAVIATE_URL=http://localhost:8080

Option 2: Weaviate Cloud (WCD)

  1. Create an account at Weaviate Cloud
  2. Create a cluster
  3. Get your cluster URL and API key

Configure .env:

WCD_URL=https://your-cluster.weaviate.network
WCD_API_KEY=your-api-key

Environment Configuration

Create a .env file in your project root:

# ============================================
# WEAVIATE CONFIGURATION
# ============================================
# Choose ONE of the following connection modes:

# Option 1: Local Weaviate Instance (Docker)
WEAVIATE_URL=http://localhost:8080
# WEAVIATE_API_KEY=           # Optional: if authentication is enabled

# Option 2: Weaviate Cloud (WCD)
# WCD_URL=https://your-cluster.weaviate.network
# WCD_API_KEY=your-wcd-api-key

# ============================================
# EMBEDDINGS (Optional)
# ============================================
# VoyageAI for vector embeddings
# VOYAGEAI_API_KEY=pa-...

# ============================================
# AI AGENT (Optional)
# ============================================
# Required for natural language queries in the shell
ANTHROPIC_API_KEY=sk-ant-...

# Claude model selection (default: claude-haiku-4-5)
AI_MODEL=claude-haiku-4-5

Verification

After installation, verify everything works:

# Check CLI version
intellyweave --version

# Show configuration
intellyweave config show

# Run setup wizard
intellyweave setup

# Test Weaviate connection
intellyweave weaviate status

Updating

To update to the latest version:

# Global installation
npm update -g intellyweave-cli

# Or reinstall
npm install -g intellyweave-cli@latest

Uninstalling

npm uninstall -g intellyweave-cli

See Also