Getting Started

Get VitalClaw running in under 5 minutes.

Prerequisites

• Node.js 22+ — required runtime
• TypeScript 5.7+ — type-safe by design
• ElizaOS (optional) — if using as an agent plugin

Installation

# npm
npm install @vitalclaw/sdk

# pnpm
pnpm add @vitalclaw/sdk

# yarn
yarn add @vitalclaw/sdk

Quick Start

Step 1: Create the Engine

import { VitalClawEngine } from "@vitalclaw/sdk";

const engine = new VitalClawEngine({
  userId: "user-001",
  providers: [],
});

Step 2: Ingest Health Data

engine.ingest([
  { id: "1", userId: "user-001", metric: "heart_rate",
    value: 72, unit: "bpm", timestamp: new Date().toISOString(), source: "fitbit" },
  { id: "2", userId: "user-001", metric: "steps",
    value: 8432, unit: "steps", timestamp: new Date().toISOString(), source: "fitbit" },
]);

Step 3: Get Insights

const summary = engine.getDailySummary();
console.log(summary.wellnessScore); // 78
console.log(summary.cardiac.restingHeartRate); // 72
console.log(summary.activity.steps); // 8432

What Happens Under the Hood

Next Steps