2026-09-22 08:38:54 +00:00
2026-09-08 12:32:59 +00:00

Volcanic Secretary

A personal assistant you talk to over Telegram. The agent engine is Pi embedded through its SDK. It lives in one workspace directory, runs tools without asking, remembers things in MEMORY.md, and can schedule reminders, prompts, and watcher scripts.

Setup (Windows or any host with Node 24)

On Windows the quickest path is run.bat, which creates .env on the first run, then installs, builds, and starts the bot on every later run. The step by step guide, including how to get the bot token and your user id, is in SETUP-WINDOWS.md.

  1. Create a bot with @BotFather and copy the token.
  2. Find your numeric Telegram user id (send /start to @userinfobot).
  3. Log in to a model provider once with pi so ~/.pi/agent/auth.json exists, or plan to set PI_MODEL plus a provider API key.
  4. Copy .env.example to .env and fill in TELEGRAM_BOT_TOKEN and TELEGRAM_OWNER_ID. Add OPENAI_API_KEY if you want voice notes transcribed.
  5. npm install, then npm run dev (development) or npm run build && npm start.

The bot messages you 🟒 Online. when it is ready. Only your user id is accepted; everyone else is ignored.

Talking to it

Send text, photos, voice notes, or files. Photos go to the model as images. Voice notes are transcribed with OpenAI and echoed back as 🎀 .... Files are saved to workspace/inbox/ and the agent is told the path.

While the agent works you see one βš™οΈ Working… message that updates with tool activity, then the answer. Send another message while it works and it is queued for the current run (you get a πŸ‘€ reaction).

It can also send files back. When you ask for a screenshot, a generated file, or a rendered report, the agent uses its send tool to attach the file directly β€” photos appear inline, other files arrive as documents.

Commands: /status, /new, /stop, /jobs, /cancel <id>, /compact.

Scheduling

Ask in plain language:

  • "Remind me at 9 tomorrow to call the dentist" (one-off, sent directly)
  • "Every weekday at 8, summarize what's in my inbox folder" (recurring prompt through the agent)
  • "Write a script that checks the price on this page every 10 minutes and tell me only if it drops below 50" (watcher script)

Watcher scripts follow one rule: print nothing and exit 0 to stay silent, print a message to trigger delivery, exit non-zero on a real error. Failures are reported once and stay quiet while the same failure repeats.

Jobs live in workspace/.secretary/jobs.json.

Workspace

workspace/
  AGENTS.md    persona and standing instructions (edit freely)
  MEMORY.md    facts the assistant keeps; it edits this itself
  scripts/     scripts for scheduled jobs
  inbox/       files you sent
  .secretary/  runtime state

The agent's edits to MEMORY.md are local runtime data. Leave them uncommitted, or run git update-index --assume-unchanged workspace/MEMORY.md.

Environment variables

Variable Required Default Purpose
TELEGRAM_BOT_TOKEN yes Bot token
TELEGRAM_OWNER_ID yes Your numeric user id
WORKSPACE_DIR no ./workspace Workspace directory
OPENAI_API_KEY no Enables voice transcription
STT_MODEL no gpt-4o-transcribe OpenAI transcription model
PI_MODEL no first model with credentials provider/model or provider/model:thinking, for example pi-claude-code-provider/opus with the Claude Code subscription package; pi --list-models shows every id
PI_CODING_AGENT_DIR no ~/.pi/agent Pi config directory (auth, settings, packages)
SECRETARY_TIMEZONE no system IANA timezone for cron and time display
SECRETARY_SHELL no Git Bash / bash Shell used for scheduled scripts
LOG_LEVEL no info debug, info, warn, error
PLAYWRIGHT_ENABLED no false Enable the Playwright MCP bridge (browser control tools)
PLAYWRIGHT_HEADLESS no true Run browser headless. false opens a visible window
PLAYWRIGHT_BROWSER no chrome chrome, firefox, webkit, or msedge
PLAYWRIGHT_EXTRA_ARGS no Extra flags passed to @playwright/mcp (shell-quoted)

Keeping it running on Windows

Use Task Scheduler (run node dist/main.js at logon, restart on failure) or npm i -g pm2 then pm2 start dist/main.js --name secretary. If Git is installed per-user or somewhere else entirely, set SECRETARY_SHELL to the full path of bash.exe.

Docker / Coolify

docker compose up -d --build runs it with two named volumes: /workspace and /pi-agent. Provide the environment through Coolify. For model auth either copy a Pi agent directory containing auth.json into the /pi-agent volume, or set ANTHROPIC_API_KEY and PI_MODEL=anthropic/claude-opus-4-7 (an id from Pi's built-in Anthropic provider, which is what an API key unlocks). The image includes bash, git, ripgrep, and Python 3 so watcher scripts work the same as on Windows.

Tests

npm test runs the unit tests. SECRETARY_SMOKE=1 npx vitest run src/agent/pi-backend.smoke.test.ts runs one real model call through Pi.

Manual end-to-end checklist

Run npm run dev with a real bot and walk through every line:

  1. hi β†’ progress message appears then disappears, reply arrives as formatted text.
  2. Long answer (explain git rebase in detail with code examples) β†’ multiple messages, code blocks render, no HTML shows raw.
  3. Photo with caption what is this β†’ reply describes the image.
  4. Voice note β†’ 🎀 <transcript> then a reply. Without OPENAI_API_KEY β†’ the not-configured note.
  5. Document (a small .csv) with caption summarize this β†’ file appears in workspace/inbox/ with date prefix, reply uses it.
  6. Send a message while a long run is in progress β†’ πŸ‘€ reaction, and the agent picks it up in the same run.
  7. /stop during a run β†’ Stopped. and no final answer message.
  8. remind me in 2 minutes to stretch β†’ confirmation with the fire time; two minutes later <job name>: <message> arrives directly.
  9. every minute run scripts/ping.py and tell me if it prints something where ping.py prints on even minutes β†’ messages arrive only on even minutes; /jobs lists it; /cancel <id> removes it.
  10. Ask it to remember a fact (remember that my dog is called Rex), then /new, then what is my dog called β†’ answer comes from MEMORY.md.
  11. Stop the daemon, start it again β†’ conversation continues (what did we just talk about).
  12. /compact β†’ reply with token counts.
  13. "Every Monday and Wednesday at 9 create a standup event for 15 minutes" β†’ an event is created with RRULE:FREQ=WEEKLY;BYDAY=MO,WE; "list the next 3 standups" returns three occurrences; "move next Wednesday's standup to 10" changes just that instance; "delete the standup series" removes them all.
  14. Start with PLAYWRIGHT_ENABLED=true. Startup log shows playwright tools enabled (N tools) with N > 20. Ask "open https://example.com and tell me the H1 text" β†’ reply contains Example Domain.
  15. With Playwright still enabled, ask "screenshot https://example.com and send it to me" β†’ an image attachment arrives.
  16. Ask "run this on example.com: async (page) => { await page.goto('https://example.com'); return await page.title(); }" β†’ reply says Example Domain. Exercises browser_run_code_unsafe.
  17. Restart with PLAYWRIGHT_ENABLED=false. Startup log shows playwright tools disabled; no browser_* tools appear in the model's tool list.
  18. Ask "write a short poem to poem.txt and send it to me" β†’ a .txt document attachment arrives with the poem inside, and the reply confirms with one line.
Description
No description provided
Readme 794 KiB
Languages
TypeScript 97.7%
Dockerfile 1%
Batchfile 0.9%
Shell 0.4%