mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-30 01:41:43 +00:00
Add a plugin system that lets plugins add new tabs to the dashboard.
Plugins live in ~/.hermes/plugins/<name>/dashboard/ alongside any
existing CLI/gateway plugin code.
Plugin structure:
plugins/<name>/dashboard/
manifest.json # name, label, icon, tab config, entry point
dist/index.js # pre-built JS bundle (IIFE, uses SDK globals)
plugin_api.py # optional FastAPI router mounted at /api/plugins/<name>/
Backend (hermes_cli/web_server.py):
- Plugin discovery: scans plugins/*/dashboard/manifest.json from user,
bundled, and project plugin directories
- GET /api/dashboard/plugins — returns discovered plugin manifests
- GET /api/dashboard/plugins/rescan — force re-discovery
- GET /dashboard-plugins/<name>/<path> — serves plugin static assets
with path traversal protection
- Optional API route mounting: imports plugin_api.py and mounts its
router under /api/plugins/<name>/
- Plugin API routes bypass session token auth (localhost-only)
Frontend (web/src/plugins/):
- Plugin SDK exposed on window.__HERMES_PLUGIN_SDK__ — provides React,
hooks, UI components (Card, Badge, Button, etc.), API client,
fetchJSON, theme/i18n hooks, and utilities
- Plugin registry on window.__HERMES_PLUGINS__.register(name, Component)
- usePlugins() hook: fetches manifests, loads JS/CSS, resolves components
- App.tsx dynamically adds nav items and routes for discovered plugins
- Icon resolution via static map of 20 common Lucide icons (no tree-
shaking penalty — bundle only +5KB over baseline)
Example plugin (plugins/example-dashboard/):
- Demonstrates SDK usage: Card components, backend API call, SDK reference
- Backend route: GET /api/plugins/example/hello
Tested: plugin discovery, static serving, API routes, path traversal
blocking, unknown plugin 404, bundle size (400KB vs 394KB baseline).
194 lines
7.9 KiB
TypeScript
194 lines
7.9 KiB
TypeScript
import { useMemo } from "react";
|
|
import { Routes, Route, NavLink, Navigate } from "react-router-dom";
|
|
import {
|
|
Activity, BarChart3, Clock, FileText, KeyRound,
|
|
MessageSquare, Package, Settings, Puzzle,
|
|
Sparkles, Terminal, Globe, Database, Shield,
|
|
Wrench, Zap, Heart, Star, Code, Eye,
|
|
} from "lucide-react";
|
|
import StatusPage from "@/pages/StatusPage";
|
|
import ConfigPage from "@/pages/ConfigPage";
|
|
import EnvPage from "@/pages/EnvPage";
|
|
import SessionsPage from "@/pages/SessionsPage";
|
|
import LogsPage from "@/pages/LogsPage";
|
|
import AnalyticsPage from "@/pages/AnalyticsPage";
|
|
import CronPage from "@/pages/CronPage";
|
|
import SkillsPage from "@/pages/SkillsPage";
|
|
import { LanguageSwitcher } from "@/components/LanguageSwitcher";
|
|
import { ThemeSwitcher } from "@/components/ThemeSwitcher";
|
|
import { useI18n } from "@/i18n";
|
|
import { usePlugins } from "@/plugins";
|
|
import type { RegisteredPlugin } from "@/plugins";
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Built-in nav items
|
|
// ---------------------------------------------------------------------------
|
|
|
|
interface NavItem {
|
|
path: string;
|
|
label: string;
|
|
labelKey?: string;
|
|
icon: React.ComponentType<{ className?: string }>;
|
|
}
|
|
|
|
const BUILTIN_NAV: NavItem[] = [
|
|
{ path: "/", labelKey: "status", label: "Status", icon: Activity },
|
|
{ path: "/sessions", labelKey: "sessions", label: "Sessions", icon: MessageSquare },
|
|
{ path: "/analytics", labelKey: "analytics", label: "Analytics", icon: BarChart3 },
|
|
{ path: "/logs", labelKey: "logs", label: "Logs", icon: FileText },
|
|
{ path: "/cron", labelKey: "cron", label: "Cron", icon: Clock },
|
|
{ path: "/skills", labelKey: "skills", label: "Skills", icon: Package },
|
|
{ path: "/config", labelKey: "config", label: "Config", icon: Settings },
|
|
{ path: "/env", labelKey: "keys", label: "Keys", icon: KeyRound },
|
|
];
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Helpers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
/** Map of icon names plugins can use. Covers common choices without importing all of lucide. */
|
|
const ICON_MAP: Record<string, React.ComponentType<{ className?: string }>> = {
|
|
Activity, BarChart3, Clock, FileText, KeyRound,
|
|
MessageSquare, Package, Settings, Puzzle,
|
|
Sparkles, Terminal, Globe, Database, Shield,
|
|
Wrench, Zap, Heart, Star, Code, Eye,
|
|
};
|
|
|
|
/** Resolve a Lucide icon name to a component, fallback to Puzzle. */
|
|
function resolveIcon(name: string): React.ComponentType<{ className?: string }> {
|
|
return ICON_MAP[name] ?? Puzzle;
|
|
}
|
|
|
|
/** Insert plugin nav items at the position specified in their manifest. */
|
|
function buildNavItems(builtIn: NavItem[], plugins: RegisteredPlugin[]): NavItem[] {
|
|
const items = [...builtIn];
|
|
|
|
for (const { manifest } of plugins) {
|
|
const pluginItem: NavItem = {
|
|
path: manifest.tab.path,
|
|
label: manifest.label,
|
|
icon: resolveIcon(manifest.icon),
|
|
};
|
|
|
|
const pos = manifest.tab.position ?? "end";
|
|
if (pos === "end") {
|
|
items.push(pluginItem);
|
|
} else if (pos.startsWith("after:")) {
|
|
const target = "/" + pos.slice(6);
|
|
const idx = items.findIndex((i) => i.path === target);
|
|
items.splice(idx >= 0 ? idx + 1 : items.length, 0, pluginItem);
|
|
} else if (pos.startsWith("before:")) {
|
|
const target = "/" + pos.slice(7);
|
|
const idx = items.findIndex((i) => i.path === target);
|
|
items.splice(idx >= 0 ? idx : items.length, 0, pluginItem);
|
|
} else {
|
|
items.push(pluginItem);
|
|
}
|
|
}
|
|
|
|
return items;
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// App
|
|
// ---------------------------------------------------------------------------
|
|
|
|
export default function App() {
|
|
const { t } = useI18n();
|
|
const { plugins } = usePlugins();
|
|
|
|
const navItems = useMemo(
|
|
() => buildNavItems(BUILTIN_NAV, plugins),
|
|
[plugins],
|
|
);
|
|
|
|
return (
|
|
<div className="flex min-h-screen flex-col bg-background text-foreground overflow-x-hidden">
|
|
<div className="noise-overlay" />
|
|
<div className="warm-glow" />
|
|
|
|
<header className="fixed top-0 left-0 right-0 z-40 border-b border-border bg-background/90 backdrop-blur-sm">
|
|
<div className="mx-auto flex h-12 max-w-[1400px] items-stretch">
|
|
<div className="flex items-center border-r border-border px-3 sm:px-5 shrink-0">
|
|
<span className="font-collapse text-lg sm:text-xl font-bold tracking-wider uppercase blend-lighter">
|
|
H<span className="hidden sm:inline">ermes </span>A<span className="hidden sm:inline">gent</span>
|
|
</span>
|
|
</div>
|
|
|
|
<nav className="flex items-stretch overflow-x-auto scrollbar-none">
|
|
{navItems.map(({ path, label, labelKey, icon: Icon }) => (
|
|
<NavLink
|
|
key={path}
|
|
to={path}
|
|
end={path === "/"}
|
|
className={({ isActive }) =>
|
|
`group relative inline-flex items-center gap-1 sm:gap-1.5 border-r border-border px-2.5 sm:px-4 py-2 font-display text-[0.65rem] sm:text-[0.8rem] tracking-[0.12em] uppercase whitespace-nowrap transition-colors cursor-pointer shrink-0 focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring ${
|
|
isActive
|
|
? "text-foreground"
|
|
: "text-muted-foreground hover:text-foreground"
|
|
}`
|
|
}
|
|
>
|
|
{({ isActive }) => (
|
|
<>
|
|
<Icon className="h-4 w-4 sm:h-3.5 sm:w-3.5 shrink-0" />
|
|
<span className="hidden sm:inline">
|
|
{labelKey ? (t.app.nav as Record<string, string>)[labelKey] ?? label : label}
|
|
</span>
|
|
<span className="absolute inset-0 bg-foreground pointer-events-none transition-opacity duration-150 group-hover:opacity-5 opacity-0" />
|
|
{isActive && (
|
|
<span className="absolute bottom-0 left-0 right-0 h-px bg-foreground" />
|
|
)}
|
|
</>
|
|
)}
|
|
</NavLink>
|
|
))}
|
|
</nav>
|
|
|
|
<div className="ml-auto flex items-center gap-2 px-2 sm:px-4">
|
|
<ThemeSwitcher />
|
|
<LanguageSwitcher />
|
|
<span className="hidden sm:inline font-display text-[0.7rem] tracking-[0.15em] uppercase opacity-50">
|
|
{t.app.webUi}
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
|
|
<main className="relative z-2 mx-auto w-full max-w-[1400px] flex-1 px-3 sm:px-6 pt-16 sm:pt-20 pb-4 sm:pb-8">
|
|
<Routes>
|
|
<Route path="/" element={<StatusPage />} />
|
|
<Route path="/sessions" element={<SessionsPage />} />
|
|
<Route path="/analytics" element={<AnalyticsPage />} />
|
|
<Route path="/logs" element={<LogsPage />} />
|
|
<Route path="/cron" element={<CronPage />} />
|
|
<Route path="/skills" element={<SkillsPage />} />
|
|
<Route path="/config" element={<ConfigPage />} />
|
|
<Route path="/env" element={<EnvPage />} />
|
|
|
|
{/* Plugin routes */}
|
|
{plugins.map(({ manifest, component: PluginComponent }) => (
|
|
<Route
|
|
key={manifest.name}
|
|
path={manifest.tab.path}
|
|
element={<PluginComponent />}
|
|
/>
|
|
))}
|
|
|
|
<Route path="*" element={<Navigate to="/" replace />} />
|
|
</Routes>
|
|
</main>
|
|
|
|
<footer className="relative z-2 border-t border-border">
|
|
<div className="mx-auto flex max-w-[1400px] items-center justify-between px-3 sm:px-6 py-3">
|
|
<span className="font-display text-[0.7rem] sm:text-[0.8rem] tracking-[0.12em] uppercase opacity-50">
|
|
{t.app.footer.name}
|
|
</span>
|
|
<span className="font-display text-[0.6rem] sm:text-[0.7rem] tracking-[0.15em] uppercase text-foreground/40">
|
|
{t.app.footer.org}
|
|
</span>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
);
|
|
}
|