symbiote-agui
v0.20.1
Published
Local interactive interfaces for AI agents, built with Symbiote.js.
Maintainers
Readme
AGUI - Agentic Generative User Interface
An interactive workspace for your AI conversation.
Symbiote AGUI lets your AI agent create a browser interface for the task you are working on together. Explore data, fill in forms, compare options, or work through a checklist while your agent responds to your choices.
Agent and model agnostic. Use AGUI with any AI agent that can run shell commands, regardless of its model or provider. The same CLI and saved interfaces remain usable when you switch agents.
The interface runs on your computer and opens in your normal browser. Your agent handles the interface code and updates it as the task changes.
Why use AGUI?
- Turn data and long chat responses into dashboards, filters, and comparison views.
- Make choices through forms, buttons, and checklists that your agent can respond to.
- Share a live view with other people while one person interacts.
- Reopen saved interfaces by name for recurring tasks.
- Keep task interfaces and their descriptions in Git so your team can reuse and improve them.
Get started
You need Node.js 24 or newer and an AI agent that can run shell commands.
Install the AGUI skill globally for your agent with the skills CLI, making it available across projects:
npx skills add rnd-pro/symbiote-agui --skill agui --globalOmit --global to install only in the current project. Keep the same scope when reinstalling or updating an existing skill.
For manual setup, use the skill source on GitHub.
Restart your agent session after installation, then ask it for an interface. For example:
Use Symbiote AGUI to create a weekly planner where I can prioritize tasks and check them off.
Your agent runs AGUI through npx symbiote-agui and opens the page for you. Use the interface and continue the conversation whenever you want to change it.
How it works
You describe a task. Your agent creates a named AGUI session and supplies its interface. The browser shows the result and sends your interactions back to the agent, which can update the page as you work.
AGUI exposes UI actions as WebMCP tools and invokes them through Symbiote.js's public API over WebSockets. Named actions and structured inputs reduce DOM inspection, screenshot analysis, and fragile click sequences, making interaction more efficient and predictable. You keep using your regular browser without drivers or remote debugging, simplifying setup. The control channel stays scoped to the AGUI page and its exposed actions, avoiding the broader browser access that browser automation can require.
AGUI runs locally by default. The CLI is enough to use it; MCP integrations are available for agent environments that support them.
Interfaces can load public documents, feeds, images, and JSON through the session asset proxy when a source does not allow browser CORS access.
Use original project logos, images, and documents as local session assets. They travel with saved interfaces and remain available through public sharing.
With a verified private feedback handler, explicit Save or Submit actions can deliver consolidated changes to the originating conversation. The agent completes the corresponding authorized external operation and verifies the result before marking it saved. Routine edits stay local, and delivery acknowledgement is separate from external persistence. The agent workflow covers setup and behavior when native delivery is unavailable.
For repeatable operations, interfaces can also call approved local connector backends directly. Reviewed scripts, private credentials, and scoped access let an AGUI work with its data sources while the agent is away.
UI library
AGUI combines the Symbiote HTML-app foundation with a themed UI library. Agents can build dynamic applications declaratively with RAT, using HTML tags and attributes without needing access to the JavaScript runtime. It speeds up UI generation and significantly reduces token consumption. See the AGUI skill for usage guidance.
Use the UI library independently in your own website through a CDN or project bundle.
App templates give your agent a ready-made layout to customize with your task's data. Starting from an existing shell reduces repeated markup, while the saved app stays editable and shareable through Git.
Manage sessions in your browser
Open the built-in session manager:
npx symbiote-agui managerSee running and saved interfaces, search their descriptions, and start, stop, rename, sync, clear, or share them directly. The manager refreshes session status automatically and can check or renew public tunnels. It works independently of your agent and stays available when you stop all sessions.
Connections shows live browser clients and tunnels across all projects. Disconnect individual clients or stop a public tunnel while keeping the interface running locally. Opening Public checks the link and renews it if needed before opening the page.
Connect your AGUI folders once, then revisit them or the default cache through Projects. Browse their saved files and copy or move interfaces between projects, choosing whether to include saved data and metadata. One manager handles every connected folder. Switching projects refreshes its contents in the same app and keeps running interfaces and drafts in place.
The manager uses the same UI library and theme as generated interfaces. It is local to your computer and uses your current library folder or private cache. See manager controls for lifecycle commands and access details.
Internet sharing
Ask your agent to enable a public tunnel and give you a viewer link. AGUI creates the tunnel automatically, without a Cloudflare account or domain.
One person uses the interactive page while others watch its updates through a viewer link. Viewers can point and draw temporary colored highlights together while application controls and data stay read-only. When the interactive user disconnects, the next eligible connection can take that role.
If a shared link stops working, run npx symbiote-agui tunnel check my-workspace to check it, then npx symbiote-agui tunnel renew my-workspace to create replacement links.
Anyone with a public link can open it. Links are temporary, and your computer and AGUI session must remain running. See sharing behavior and limits.
Reopen or finish a session
Browser tabs show the session ID as their title and use a stable colored emoji favicon to help distinguish interfaces.
Ask your agent to reopen a session by name, stop it when you are finished, or clear it when you want to discard the saved interface and data. Reopening restores the interface and explicitly committed data. Ordinary edits remain unsaved until a Save action commits declared provider properties to the private data cache.
Data-editing interfaces use one floating status button that opens Save, Cancel changes, and manual JSON import/export controls. Import stays a draft until Save; export includes unsaved edits and remains available while disconnected. Local saving, agent delivery, and verified external writes have separate statuses.
List all sessions with active/inactive status and current links for running sessions, check one session, or stop it yourself:
npx symbiote-agui status all
npx symbiote-agui status my-workspace
npx symbiote-agui stop my-workspaceRun npx symbiote-agui start all to reopen all saved sessions, reusing those already running. To stop every session and its tunnel while keeping saved interfaces, run npx symbiote-agui stop all.
Build a shared team library
Choose a folder inside your team's Git checkout:
npx symbiote-agui config folder ./aguisAGUI saves each interface as an HTML file with a Markdown description. Include the folder and .agui.json in your normal Git workflow. Your agent can discover an existing interface, adapt it as the task evolves, and load your teammates' changes. Runtime connections and control tokens stay on your computer.
Without a folder setting, AGUI keeps using its private cache. See the team library guide for discovery, descriptions, and syncing running interfaces.
Sessions can also describe their initial data source, provider bindings, and intended destinations. Inspect this through describe, search it with list --query, or view it in the manager. The metadata commands maintain this information privately without changing application data or starting a worker.
Built with
Symbiote.js and Runtime Agnostic Templates (RAT) provide reactive interfaces built from portable HTML templates. JSDA-Kit serves pages and assets on demand, keeping AGUI ready to run without a separate application build setup.
Learn more
- Session controls, sharing limits, and optional integrations
- AGUI skill for agents creating and operating interfaces
- Package on npm
Contributing
Bug reports, ideas, and focused pull requests are welcome. Read the contributing guide and Code of Conduct before participating.
License
MIT © RND-PRO.com
