Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/hunvreus/heypi/llms.txt

Use this file to discover all available pages before exploring further.

Heypi gives your team AI chat agents that can actually do things—run shell commands, call APIs, manage files—while keeping humans in the loop with native approval buttons in Slack, Discord, and Telegram. Built on top of Pi, it adds persistent threads, sandboxed runtimes, scheduled jobs, and a web admin panel so you can run production agents with confidence.

Quickstart

Install Heypi and have a working Slack agent running in minutes.

Agent Folder

Structure your agent’s identity, rules, skills, and extensions.

Tools & Approvals

Build custom tools with human-in-the-loop approval flows.

Adapters

Connect to Slack, Discord, Telegram, or generic webhooks.

Why Heypi

Most AI chat integrations are demo-quality: no persistence, no safety rails, no operational visibility. Heypi is designed for teams that need agents running in production channels, with auditable tool execution and humans in control of consequential actions.

Safe by Default

Network-disabled just-bash runtime, command risk classification, and approval gates before any dangerous action runs.

Multi-Platform

One agent, four delivery channels: Slack, Discord, Telegram, and a generic webhook HTTP API.

Persistent State

SQLite-backed threads, approvals, jobs, and memory—so the agent picks up where it left off after a restart.

Scheduled Jobs

Cron and heartbeat jobs for proactive agent turns—daily health checks, idle incident follow-ups, and more.

Scoped Memory

Per-channel or per-user memory files give agents durable background context across conversations.

Admin UI

Web panel for inspecting threads, pending approvals, scheduled jobs, and agent configuration.

Get Started

1

Install the package

npm install @hunvreus/heypi
2

Create your agent folder

Add an agent/SOUL.md with your agent’s identity and agent/AGENTS.md with its operating rules.
3

Wire up an adapter

Pick Slack, Discord, Telegram, or webhook and pass your credentials to createHeypi().
4

Run your agent

node index.js
Heypi starts all adapters, connects to your chat platform, and listens for messages.

Packages

@hunvreus/heypi

Core runtime, adapters, admin UI, tools, scheduler, and CLI. Start here.

heypi-runtime-docker

Experimental Docker provider—one warm container per runtime scope.

heypi-runtime-gondolin

Experimental Gondolin VM provider—one warm VM per runtime scope.

Examples

Slack DevOps Assistant

SSH host tools, runbook search, approvals, and scheduled health checks.

Discord Project Agent

Project notes, status updates with approval gates, and streaming replies.

Telegram Fitness Coach

Onboarding flow, saved profile, daily heartbeat check-ins, and a workout log.

Webhook Notes Agent

Minimal note-taking agent with a generic HTTP API and curl examples.

Build docs developers (and LLMs) love