About this project

This repository provides the official JavaScript/TypeScript SDKs for building applications with Octavus AI agents. It is organized as a monorepo containing several npm packages, each targeting a different part of the integration surface. Packages include @octavus/core for shared types and utilities used in client/server communication, @octavus/server-sdk for backend integration, @octavus/client-sdk as a framework-agnostic client, @octavus/react for React hooks and bindings, @octavus/cli for agent management, and @octavus/docs for documentation content. The server SDK demonstrates creating an OctavusClient with an API key, creating an agent session with initial variables, attaching to that session with custom tool handlers, and triggering a named trigger while streaming response events such as text deltas. The React package shows a useOctavusChat hook combined with an HTTP transport, where a trigger request is forwarded to a backend endpoint and messages, status and a send function are exposed to the UI. Documentation links cover getting started, server SDK, client SDK, protocol reference and API reference. Development requires Node.js 20+ and pnpm 10+, with scripts for install, build, lint, type-check and format. The project is MIT licensed and accepts contributions via a contributing guide.