Skip to main content
Building an app? The SDK is the production entry point. Start with the SDK Quick Start before reading anything else on this page.

SDK — Embed in Node.js

The production entry point. Import GitAgent directly into your Node.js application and call query() to send prompts programmatically.
// app.ts
import { query } from "@open-gitagent/gitagent";

for await (const msg of query({
  prompt: "Summarise yesterday's tasks",
  dir: "./my-agent",
})) {
  if (msg.type === "assistant") console.log(msg.content);
}
Links: SDK Quick Start · SDK Reference

Personal Assistant

Run GitAgent as a local assistant with multiple ways to interact — terminal, browser, or messaging apps.
  • CLI — Interactive terminal REPL — launch an agent session from your shell.
  • Web & Voice — Full browser UI with chat, skills, scheduler, and real-time voice.
  • Messaging — Connect to Telegram, WhatsApp, or phone via Twilio.
See the Personal Assistant Quick Start to get running in minutes.

SDK Quick Start

Install the SDK and call query() from your own Node.js app

Personal Assistant Quick Start

Run GitAgent locally via CLI, browser, or messaging apps

Architecture

The agent directory structure and agent.yaml schema

SDK Reference

Full query(), tool(), and hooks API reference