vellum 0.0.16 → 0.2.0

package/.dockerignore

@@ -0,0 +1,27 @@
+# Dependency directories
+node_modules/
+
+# Log files
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# OS files
+.DS_Store
+
+# Version control
+.git/
+.gitignore
+
+# Docker
+.dockerignore
+
+# Local env files
+.env
+.env.*
+
+# Build artifacts
+dist/
+out/
+build/

package/.env.example

@@ -0,0 +1,22 @@
+# AI Provider API Keys
+ANTHROPIC_API_KEY=sk-ant-...
+OPENAI_API_KEY=sk-...
+GEMINI_API_KEY=...
+# Optional for authenticated/proxied Ollama deployments
+OLLAMA_API_KEY=
+# Optional override (defaults to http://127.0.0.1:11434/v1)
+OLLAMA_BASE_URL=
+
+# --- Remote Access ---
+
+# Override the daemon socket path (default: ~/.vellum/vellum.sock).
+# Use this to target a forwarded or remote socket.
+# VELLUM_DAEMON_SOCKET=/path/to/remote/vellum.sock
+
+# Control daemon autostart behavior.
+# When VELLUM_DAEMON_SOCKET is set, autostart is disabled by default.
+# Set to 1 to force autostart even with a custom socket path.
+# VELLUM_DAEMON_AUTOSTART=1
+
+# Enable the runtime HTTP server (required for web local mode).
+# RUNTIME_HTTP_PORT=7821

package/Dockerfile

@@ -0,0 +1,99 @@
+# Use debian as base image
+FROM us-central1-docker.pkg.dev/code-executor-service/base-images/debian:bookworm@sha256:940221f8c2564efc4e7909caba7014dc8bcba7f05b7881eb2b557b4058c41269 AS builder
+
+WORKDIR /app
+
+# Install build dependencies
+RUN apt-get update && apt-get install -y \
+    curl \
+    unzip \
+    python3 \
+    make \
+    g++ \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install bun
+RUN curl -fsSL https://bun.sh/install | bash
+ENV PATH="/root/.bun/bin:${PATH}"
+
+# Copy package files
+COPY package.json bun.lock ./
+
+# Install dependencies
+RUN bun install --frozen-lockfile
+
+# Copy source
+COPY . .
+
+# Final stage
+FROM debian:bookworm AS runner
+
+WORKDIR /app
+
+# Install runtime dependencies for Playwright and tree-sitter
+RUN apt-get update && apt-get install -y \
+    curl \
+    unzip \
+    ca-certificates \
+    python3 \
+    libnss3 \
+    libfreetype6 \
+    libharfbuzz0b \
+    fonts-freefont-ttf \
+    make \
+    g++ \
+    sudo \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy bun binary from builder instead of re-installing
+COPY --from=builder /root/.bun/bin/bun /usr/local/bin/bun
+
+# Create non-root user that also has sudo access so it can like install stuff
+RUN groupadd --system --gid 1001 assistant && \
+    useradd --system --uid 1001 --gid assistant --create-home --shell /bin/bash assistant && \
+    echo "assistant ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
+
+# Copy from builder
+COPY --from=builder /app /app
+
+# Set up data directory
+RUN mkdir -p /home/assistant/.vellum /data && \
+    chown -R assistant:assistant /home/assistant/.vellum /data && \
+    chmod a+rwx /data
+
+# Update PATH for assistant user
+ENV PATH="/home/assistant/.bun/bin:/data/bin:${PATH}"
+
+# Configure package managers to use /data
+ENV BUN_INSTALL="/data/.bun"
+ENV PATH="${BUN_INSTALL}/bin:${PATH}"
+ENV PYTHONUSERBASE="/data/.python"
+ENV PATH="${PYTHONUSERBASE}/bin:${PATH}"
+
+# Configure apt/dpkg to install future packages to /data
+RUN mkdir -p /data/dpkg/info /data/dpkg/updates /data/dpkg/triggers && \
+    mkdir -p /data/usr/bin /data/usr/lib /data/usr/share && \
+    chown -R assistant:assistant /data/dpkg /data/usr
+
+# Create dpkg configuration for using /data as install prefix
+RUN echo 'Dir::State "/data/dpkg";' > /etc/apt/apt.conf.d/99data-dir && \
+    echo 'Dir::State::status "/data/dpkg/status";' >> /etc/apt/apt.conf.d/99data-dir && \
+    echo 'Dir::Cache "/data/apt/cache";' >> /etc/apt/apt.conf.d/99data-dir && \
+    echo 'DPkg::Options {"--instdir=/data/usr";"--admindir=/data/dpkg";"--force-not-root";"--force-bad-path";};' >> /etc/apt/apt.conf.d/99data-dir && \
+    mkdir -p /data/apt/cache && \
+    touch /data/dpkg/status && \
+    chown -R assistant:assistant /data/apt /data/dpkg
+
+ENV PATH="/data/usr/bin:/data/usr/sbin:${PATH}"
+ENV LD_LIBRARY_PATH="/data/usr/lib:/data/usr/lib/x86_64-linux-gnu:${LD_LIBRARY_PATH}"
+
+USER assistant
+
+EXPOSE 3001
+
+ENV RUNTIME_HTTP_PORT=3001
+ENV VELLUM_DAEMON_SOCKET=/home/assistant/.vellum/vellum.sock
+ENV BASE_DATA_DIR=/data
+
+# Run the daemon + http server
+CMD ["bun", "run", "src/daemon/main.ts"]

package/Dockerfile.sandbox

@@ -0,0 +1,5 @@
+FROM node:20-slim
+
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends curl ca-certificates bash jq python3 \
+ && rm -rf /var/lib/apt/lists/*

package/README.md

@@ -1,9 +1,156 @@
-# vellum
+# Vellum Assistant Runtime
 
-> **Warning**: This package is still under heavy beta testing and should not be run by others.
+Bun + TypeScript daemon that owns conversation history, attachment storage, and channel delivery state in a local SQLite database. Exposes a Unix domain socket (macOS) and optional TCP listener (iOS) for native clients, plus an HTTP API consumed by the gateway.
+
+## Architecture
+
+```
+CLI / macOS app / iOS app
+        │
+        ▼
+   Unix socket (~/.vellum/vellum.sock)
+        │
+        ▼
+   DaemonServer (IPC)
+        │
+        ├── Session Manager (in-memory pool, stale eviction)
+        │       ├── Anthropic Claude (primary)
+        │       ├── OpenAI (secondary)
+        │       ├── Google Gemini (secondary)
+        │       └── Ollama (local models)
+        │
+        ├── Memory System (FTS5 + Qdrant + Entity Graph)
+        ├── Skill Tool System (bundled + managed + workspace)
+        ├── Swarm Orchestration (DAG scheduler + worker pool)
+        ├── Script Proxy (credential injection + MITM)
+        └── Tracing (per-session event emitter)
+```
+
+## Setup
+
+```bash
+cd assistant
+bun install
+cp .env.example .env
+# Edit .env with your API keys
+```
+
+## Configuration
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `ANTHROPIC_API_KEY` | Yes | — | Anthropic Claude API key |
+| `OPENAI_API_KEY` | No | — | OpenAI API key |
+| `GEMINI_API_KEY` | No | — | Google Gemini API key |
+| `OLLAMA_API_KEY` | No | — | API key for authenticated Ollama deployments |
+| `OLLAMA_BASE_URL` | No | `http://127.0.0.1:11434/v1` | Ollama base URL |
+| `RUNTIME_HTTP_PORT` | No | — | Enable the HTTP server (required for gateway/web) |
+| `VELLUM_DAEMON_SOCKET` | No | `~/.vellum/vellum.sock` | Override the daemon socket path |
 
 ## Usage
 
+### Start the daemon
+
+```bash
+bun run src/index.ts daemon start
+```
+
+### Interactive CLI
+
+```bash
+bun run src/index.ts
+```
+
+### Dev mode (auto-restart on file changes)
+
+```bash
+bun run src/index.ts dev
+```
+
+### CLI commands
+
+| Command | Description |
+|---------|-------------|
+| `vellum` | Launch interactive CLI session |
+| `vellum daemon start\|stop\|restart\|status` | Manage the daemon process |
+| `vellum dev` | Run daemon with auto-restart on file changes |
+| `vellum sessions list\|new\|export\|clear` | Manage conversation sessions |
+| `vellum config set\|get\|list` | Manage configuration |
+| `vellum keys set\|list\|delete` | Manage API keys in secure storage |
+| `vellum trust list\|remove\|clear` | Manage trust rules |
+| `vellum doctor` | Run diagnostic checks |
+
+## Project Structure
+
+```
+assistant/
+├── src/
+│   ├── index.ts              # CLI entrypoint (commander)
+│   ├── cli.ts                # Interactive REPL client
+│   ├── daemon/               # Daemon server, IPC protocol, session management
+│   ├── agent/                # Agent loop and LLM interaction
+│   ├── providers/            # LLM provider integrations (Anthropic, OpenAI, Gemini, Ollama)
+│   ├── memory/               # Conversation store, memory indexer, recall (FTS5 + Qdrant)
+│   ├── skills/               # Skill catalog, loading, and tool factory
+│   ├── tools/                # Built-in tool definitions
+│   ├── swarm/                # Swarm orchestration (DAG scheduler, worker pool)
+│   ├── permissions/          # Trust rules and permission system
+│   ├── security/             # Secure key storage, credential broker
+│   ├── config/               # Configuration loader and schema
+│   ├── runtime/              # HTTP runtime server
+│   ├── messaging/            # Message processing pipeline
+│   ├── context/              # Context assembly and compaction
+│   ├── playbooks/            # Channel onboarding playbooks
+│   ├── home-base/            # Home Base app-link bootstrap
+│   ├── hooks/                # Git-style lifecycle hooks
+│   ├── media/                # Media processing and attachments
+│   ├── schedule/             # Reminders and scheduling
+│   ├── tasks/                # Task management
+│   ├── workspace/            # Workspace file operations
+│   ├── events/               # Domain event bus
+│   ├── export/               # Session export (markdown/JSON)
+│   ├── util/                 # Shared utilities
+│   └── __tests__/            # Test suites
+├── drizzle/                  # Database migrations
+├── drizzle.config.ts         # Drizzle ORM config (SQLite)
+├── docs/                     # Internal documentation
+├── scripts/                  # Test runners and IPC codegen
+├── Dockerfile                # Production container image
+├── Dockerfile.sandbox        # Sandbox container for bash tool
+└── package.json
+```
+
+## Database
+
+SQLite via Drizzle ORM, stored at `~/.vellum/workspace/data/db/assistant.db`. Key tables include conversations, messages, tool invocations, attachments, memory segments (with FTS5), memory items, entities, and reminders.
+
+Run migrations:
+
+```bash
+bun run db:generate   # Generate migration SQL
+bun run db:push       # Apply migrations
+```
+
+## Docker
+
+```bash
+# Build production image
+docker build -t vellum-assistant:local assistant
+
+# Run
+docker run --rm -p 3001:3001 \
+  -e ANTHROPIC_API_KEY=... \
+  vellum-assistant:local
+```
+
+The image runs as non-root user `assistant` (uid 1001) and exposes port `3001`.
+
+## Development
+
 ```bash
-bunx vellum hatch
+cd assistant
+bun install
+bun run typecheck   # TypeScript type check (tsc --noEmit)
+bun run lint        # ESLint
+bun run test        # Run test suite
 ```