mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-21 16:18:55 +00:00
Add an end-to-end developer guide for extending the native Hermes Desktop app introduced in #60638: the HermesPlugin contract, PluginContext, every contribution area (panes, routes, sidebar nav, status/title bar, palette, keybinds, themes, composer, mount-scoped Contribute), the host API, the React Query + nanostores data layer, the UI kit + theme variables, the scoped ctx.rest/ctx.socket backend (plugin_api.py under /api/plugins/<id>) and its separate enable gate, Settings/defaultEnabled/storage, bundled plugins, the security model, pitfalls, and a full reference. - Register the page in the sidebar under Extending -> Plugins. - Disambiguate from the unrelated web-dashboard plugin SDK from both directions, and add a map-table row + a desktop user-guide pointer. - Fill the gaps in the agent-facing hermes-desktop-plugins skill (ctx.rest/socket + backend, React Query, defaultEnabled, Contribute) and point it at the new reference so agents know the SDK when writing addons. |
||
|---|---|---|
| .. | ||
| docs | ||
| i18n/zh-Hans/docusaurus-plugin-content-docs/current | ||
| scripts | ||
| src | ||
| static | ||
| .gitignore | ||
| docusaurus.config.ts | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.ts | ||
| tsconfig.json | ||
Website
This website is built using Docusaurus, a modern static website generator.
Installation
yarn
Local Development
yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
USE_SSH=true yarn deploy
Not using SSH:
GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Diagram Linting
CI runs ascii-guard to lint docs for ASCII box diagrams. Use Mermaid (````mermaid`) or plain lists/tables instead of ASCII boxes to avoid CI failures.