Vyogo AI by Vyogo Technologies is an in-desk AI assistant for Frappe and ERPNext. It streams answers from the Vyogo AI agent over HTTP and renders markdown prose plus structured KPI / chart / table blocks in a chat sidebar. The repository and Frappe app module are named frappe_ai.
- Chat sidebar embedded in the Frappe desk, toggled from the navbar or a custom keyboard shortcut
- Streamed responses relayed through
frappe.realtime(no separate SSE proxy in the browser) - Per-user conversation history persisted as
AI Chat Session/AI Chat Messagedoctypes - Page-context forwarding: the agent sees the user's current route / doctype / docname for grounded answers
- Authentication via the user's existing
sidcookie — no extra OAuth client to provision - Multi-site aware: every request to the agent names the site it came from, so one agent can serve many sites on a shared bench
- Writes need the user's say: a create, update or delete the assistant wants to make shows an Allow / Deny card, and runs only on a one-time token this app mints and the MCP server redeems. An administrator can auto-approve creates and updates, auto-approve everything, or make the assistant read-only
bench get-app https://github.com/vyogotech/frappe_ai
bench --site your-site install-app frappe_ai
bench restartThen set the agent URL in sites/your-site/site_config.json:
{
"frappe_ai_agent_url": "http://localhost:8484"
}And open /app/ai-assistant-settings to toggle Enabled.
Or install the released package with FPM, which ships the compiled desk bundle and needs no build step on the bench:
fpm repo add vyogo https://fpm.vyogo.tech --username <user> # or: fpm repo add ghcr ghcr.io/vyogotech/fpm --type oci
fpm install vyogotech/frappe_ai --bench-path /path/to/bench --site your-siteSee QUICKSTART.md for a 5-minute walkthrough or INSTALLATION.md for the full guide.
This app also lets a site owner connect the site to FrappeForge, the AI engineering workspace for Frappe. FrappeForge can then read customizations and propose releases that a System Manager approves, with a change log and one-click rollback. See docs/FRAPPEFORGE.md.
Click the AI button in the navbar (or press your configured shortcut) and type a query. Examples:
- "Show me all open projects"
- "What are the top customers by revenue?"
- "List pending sales orders"
| Where | Key | Purpose |
|---|---|---|
site_config.json |
frappe_ai_agent_url |
Agent endpoint (authoritative) |
site_config.json |
frappe_ai_max_auto_approved_writes |
How many auto-approved writes one message may chain before the next one shows a card again (default 20) |
| AI Assistant Settings | enabled |
Master switch |
| AI Assistant Settings | write_approval |
What happens when the assistant wants to change data: ask every time (default), auto-approve creates and updates, auto-approve all changes, or read only |
| AI Assistant Settings | allow_session_auto_approve |
Adds "Allow all in this conversation" to the card (creates and updates only; deletes always ask) |
| AI Assistant Settings | timeout |
Per-request timeout (1–300s) |
| AI Assistant Settings | sidebar_width |
Sidebar width in px (300–600) |
| AI Assistant Settings | keyboard_shortcut |
Toggle combo (e.g. Alt+/) |
MIT