Weavr Docs - Getting Started

Prerequisites

Node.js 22+ - Required for running Weavr
npm - For installing dependencies
Git - For cloning the repository

Optional: For AI agent features, you'll need an API key from Anthropic or OpenAI.

Installation

One-liner (Recommended)

Install everything with a single command:

# Works on macOS, Linux, and WSL
curl -fsSL https://openweavr.ai/install.sh | bash

This script will:

Check for Node.js 22+ (and install it if needed)
Clone the repository to ~/.weavr
Install dependencies and build
Add weavr command to your PATH

After installation: Run source ~/.zshrc (or restart your terminal) to use the weavr command.

Manual Installation

If you prefer to install manually:

# Clone the repository
git clone https://github.com/openweavr/Openweavr.git ~/.weavr
cd ~/.weavr

# Install dependencies
npm install

# Build backend and web UI
npm run build

npm

Install globally via npm (requires Node.js 22+):

npm install -g @openweavr/weavr

Homebrew (macOS)

Install via Homebrew on macOS:

brew tap openweavr/tap
brew install weavr

Verify Installation

weavr --version
weavr doctor

Uninstall

To remove Weavr:

curl -fsSL https://openweavr.ai/uninstall.sh | bash

# Keep your config and workflows
curl -fsSL https://openweavr.ai/uninstall.sh | bash -s -- --keep-config

Configuration

Weavr stores configuration in ~/.weavr/config.yaml.

Initial Setup

Run the onboard command to create your configuration:

# Interactive setup
node weavr.mjs onboard

# Non-interactive (for scripts/CI)
node weavr.mjs onboard --non-interactive --ai-provider anthropic

Manual Configuration

Or create the config file manually:

# ~/.weavr/config.yaml

# LLM Provider (for AI agents)
anthropicKey: sk-ant-...
model: claude-sonnet-4-20250514

# Or use OpenAI
# openaiKey: sk-...
# model: gpt-4o

# Server settings (optional)
port: 3847
host: localhost

# Scheduler persistence (optional)
scheduler:
  dbPath: /path/to/scheduler.db

Environment Variables

Variable	Purpose
ANTHROPIC_API_KEY	Anthropic API key for Claude models
OPENAI_API_KEY	OpenAI API key for GPT models
BRAVE_API_KEY	Brave Search API for web search
GITHUB_TOKEN	GitHub personal access token
TELEGRAM_BOT_TOKEN	Telegram bot token from BotFather

First Workflow

Create a simple workflow to verify everything works.

Create the Workflow

# Create workflow directory
mkdir -p ~/.weavr/workflows

# Create a simple workflow
cat > ~/.weavr/workflows/hello.yaml << 'EOF'
name: hello-world
description: A simple test workflow

steps:
  - id: greet
    action: transform
    with:
      template: "Hello from Weavr!"

  - id: log
    action: log
    needs: [greet]
    with:
      message: "{{ steps.greet }}"
EOF