Skip to content

Mintlify docs GitHub

Get started

Overview

Genesis
Showcase
Features

First steps

Getting started
Onboarding overview
Onboarding (CLI)
Onboarding (macOS app)

Guides

Personal assistant setup
CLI setup reference
CLI automation

Install

Install overview

Install
Installer internals
Node.js

Containers

Ansible
Bun (experimental)
ClawDock
Docker
Nix
Podman

Hosting

Azure
DigitalOcean
Docker VM runtime
exe.dev
Fly.io
GCP
Hetzner
Hostinger
Kubernetes
Linux server
macOS VMs
Northflank
Oracle Cloud
Railway
Raspberry Pi
Render

Maintenance

Updating
Migration guide
Matrix migration
Uninstall
Release channels

Advanced setup

Setup
Pi development workflow

Channels

Overview

Chat channels

Mainstream messaging

Discord
Slack
Telegram
WhatsApp
Signal
Microsoft Teams
Google Chat
iMessage
BlueBubbles
Matrix
Matrix push rules for quiet previews

Developer and self-hosted

IRC
Mattermost
Nextcloud Talk
Nostr
Tlon
Synology Chat
Twitch

Regional platforms

LINE
WeChat
Feishu
Zalo
Zalo personal

Configuration

Pairing
Group messages
Groups
Broadcast groups
Channel routing
Channel location parsing
Channel troubleshooting
QA channel

Agents

Fundamentals

Gateway architecture
Agent runtime
Agent loop
Agent runtimes
System prompt
Context
Context engine
Agent workspace
SOUL.md personality guide
OAuth
MCP OAuth
Agent bootstrapping
Experimental features
QA E2E automation

Sessions and memory

Session management
Session pruning
Session tools
Memory overview
Builtin memory engine
QMD memory engine
Honcho memory
Memory search
Active memory
Dreaming
Compaction

Multi-agent

Multi-agent routing
Presence
Delegate architecture

Messages and delivery

Messages
Streaming and chunking
Retry policy
Command queue

Tools & Plugins

Overview

Tools and plugins

Plugins

Plugins
Community plugins
Plugin bundles
Codex harness
Google Meet plugin
Webhooks plugin
Voice call plugin
Memory wiki
Message presentation
Skill workshop plugin
Zalo personal plugin
Building plugins
Plugin hooks
Building channel plugins
Building provider plugins
Plugin compatibility
Plugin SDK migration
Plugin SDK overview
Plugin SDK subpaths
Plugin entry points
Plugin runtime helpers
Agent harness plugins
Plugin setup and config
Plugin testing
Plugin manifest
Plugin internals
Plugin architecture internals

Skills

Skills
Creating skills
Skills config
Slash commands
ClawHub
OpenProse

Automation and tasks

Automation & tasks
Scheduled tasks
Background tasks
Task flow
Standing orders
Hooks

Tools

Agent coordination

Agent send
Sub-agents
ACP agents
ACP agents — setup
Multi-agent sandbox & tools

Models

Overview

Provider directory
Model provider quickstart

Concepts and configuration

Models CLI
Model providers
Model failover

Providers

Platforms

Platforms overview

Platforms
macOS app
Linux app
Windows
Android app
iOS app

macOS companion app

macOS dev setup
Menu bar
Menu bar icon
macOS permissions
macOS signing
Gateway on macOS
Gateway lifecycle
Health checks (macOS)
macOS logging
Remote control
macOS IPC
Voice wake (macOS)
Voice overlay
WebChat (macOS)
Canvas
Skills (macOS)
Peekaboo bridge

Gateway & Ops

Gateway

Remote access

Remote access
Remote gateway setup
Tailscale

Security

Formal verification (security models)
Threat model (MITRE ATLAS)
Contributing to the threat model

Nodes and media

Nodes
Node troubleshooting
Media understanding
Image and media support
Audio and voice notes
Camera capture
Text-to-speech
Talk mode
Voice wake
Location command

Web interfaces

Web
Control UI
Dashboard
WebChat
TUI

Reference

CLI commands

RPC and API

RPC adapters
Device model database

Templates

Default AGENTS.md
AGENTS.md template
BOOT.md template
BOOTSTRAP.md template
HEARTBEAT.md template
IDENTITY template
SOUL.md template
TOOLS.md template
USER template

Technical reference

Pi integration architecture
Onboarding reference
Token use and costs
SecretRef credential surface
Prompt caching
API usage and costs
Transcript hygiene
Memory configuration reference
Rich output protocol
Session management deep dive
Date and time

Concept internals

TypeBox
Markdown formatting
Typing indicators
Usage tracking
Timezones
GPT-5.4 / Codex agentic parity
GPT-5.4 / Codex parity maintainer notes

Project

Credits

Release and CI

Release policy
Tests
CI pipeline
Scripts

Help

Start here

Help
General troubleshooting
Debugging

FAQ

FAQ
FAQ: first-run setup
FAQ: models and auth

Testing

Testing
Testing: live suites

Diagnostics

Environment variables
Diagnostics flags
Node + tsx crash

Community and meta

Genesis lore
Docs hubs
Docs directory

Heartbeat

This page is listed in the docs navigation, but no source file was found.

Edit source on GitHub Open canonical docs