examples

package
v0.1.20 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2026 License: MIT Imports: 1 Imported by: 0

README

examples/

Operator templates and a usable personal-assistant skeleton.

Path What it is
persona/*.example.md System-prompt templates (gantry init embeds these)
mcp.toml.example / env.example Embedded by gantry init
personal-assistant/ appliance-style compose stack — copy, fill .env, docker compose up

Production local-agent (tools + remote deploy) lives in ../local-agent/. Deploy styles: native · Docker.


Path A — local REPL (fastest)

make init          # → deploy/persona + deploy/mcp.toml + .env.example
cp .env.example .env
# set LLM_* ; CHANNEL=stdio is fine for make run
make run           # CHANNEL=stdio PERSONA_DIR=./deploy/persona

Slash commands: /new /cancel /status /tools /perf /memstats /toolstats /auth /help /quit.


Path B — Telegram bot (Docker Hub kernel)

Compose pulls shotah/ai-gantry:latest by default — no local build.

make example-pa    # seed examples/personal-assistant/persona + .env
# edit examples/personal-assistant/.env
#   GEMINI_API_KEY=...
#   TELEGRAM_BOT_TOKEN=...
#   TELEGRAM_ALLOWED_USERS=123456789

docker compose -f examples/personal-assistant/compose.yml up -d
docker compose -f examples/personal-assistant/compose.yml logs -f

Full walkthrough: personal-assistant/README.md · docs/deploy-docker.md.


cd local-agent
make init    # edit .env
make build && make up
# remote: set DEPLOY_* then make remote-deploy

Walkthrough: local-agent/README.md. Same gantry contract (PERSONA_DIR, MCP_MANIFEST, DATA_DIR); richer image.


Persona & MCP rules of thumb

  • Concat order: SOULRULESUSERTOOLS (then other *.md). Missing files are skipped.
  • Do not commit filled-in personal *.md or .env.
  • mcp.toml: listed server = may start. Prefer --tool-tier core / tools = […] so Flash is not fed huge schemas. Boot logs tools_listed vs tools_published.
  • Data: $DATA_DIR/gantry.db holds sessions, memory, cron, heartbeat — survives image rebuilds if the volume mount stays.

Slash commands: /new, /cancel, /status, /tools, /perf, /memstats, /toolstats, /auth, /help. Unix: kill -HUP <pid> reloads persona. Telegram photos: inbound → vision; outbound SendPhoto for image URLs in replies.

Documentation

Overview

Package examples embeds operator templates for `gantry init`. Keep files here as the source of truth; deploy/ is a thin local-dev mount.

Index

Constants

This section is empty.

Variables

FS holds persona templates and the sample MCP manifest.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL