Who it is forA developer who wants to add a custom page or panel to the ZCode interface.
The problemPlugin APIs and the install and update flow are documented separately from the code, so a guided start saves time.
The outcomeA working UI plugin tested in the web dev server and prepared for a zcode-plugins pull request.
What you need first
- Git
- Node.js 24.14.0 and pnpm 10.33.2, as pinned in mise.toml
- Clone of the zai-org/ZCode repository
- A local project folder to point the agent at
Steps
- Read UI_PLUGIN.md for plugin capabilities, the page API, install and update steps and host debugging entry points.
- Start from the Excalidraw canvas collaboration example described in that guide.
- Run
pnpm dev:weband openhttp://localhost:5173to check the plugin page in the browser. - Before opening a PR to zcode-plugins, declare whether it is a UI Plugin and enter the plugin name in the PR template.
Prompt for your agent
In the zai-org/ZCode repo, read UI_PLUGIN.md and build a plugin named <plugin-name> following the Excalidraw example. Report the files created and confirm that the plugin page loads at http://localhost:5173 under `pnpm dev:web`.
Caveat. The README only links to UI_PLUGIN.md, so the exact plugin API details must be taken from that file rather than from this README.
Get 5 new use cases every morning. Free, one short email, unsubscribe anytime.
Get them freeShare: X LinkedIn Hacker News Email Copy link
Disclaimer
Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked "Seen in the wild", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email [email protected] and we will look at it promptly. Full disclaimer page