npm package: @moxxy/web-plugin
Description: <p align="center">   <img src="https://moxxy.ai/logo-gradient.svg" alt="moxxy" width="120" /> </p>
Latest version: 0.0.11

<p align="center">
  <img src="https://moxxy.ai/logo-gradient.svg" alt="moxxy" width="120" />
</p>

<h3 align="center">@moxxy/web-plugin</h3>

<p align="center">
  Browser-based management dashboard for the <a href="https://github.com/moxxy-ai/moxxy">Moxxy</a> self-hosted multi-agent AI framework.
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/@moxxy/web-plugin"><img src="https://img.shields.io/npm/v/@moxxy/web-plugin?style=flat-square&color=cb3837&logo=npm&logoColor=white&label=npm" alt="npm"></a>
  <img src="https://img.shields.io/badge/node-%E2%89%A522-5FA04E?style=flat-square&logo=node.js&logoColor=white" alt="Node.js 22+">
  <a href="#license"><img src="https://img.shields.io/badge/license-MIT%20%2F%20Apache--2.0-blue?style=flat-square" alt="License"></a>
</p>

<p align="center">
  <a href="https://docs.moxxy.ai">Documentation</a> ·
  <a href="https://moxxy.ai">Website</a> ·
  <a href="https://github.com/moxxy-ai/moxxy">GitHub</a>
</p>

---

Runs as a Moxxy plugin, connecting to the gateway's REST API and SSE event stream. Provides a complete web interface for managing agents, monitoring events, and configuring your self-hosted Moxxy deployment.

## Features

- **Dashboard overview** - gateway health, active agent count, recent events
- **Agent management** - create, configure, delete agents; start/stop runs with real-time SSE streaming
- **Memory explorer** - search and compact agent long-term memory
- **Skills manager** - install, approve, and remove agent skills
- **Template gallery** - create and assign agent templates
- **Event stream** - live SSE event viewer with type and agent filtering
- **Audit log** - paginated, searchable audit log browser
- **Vault** - manage secrets and agent access grants
- **Heartbeats** - configure cron and interval-based scheduled tasks
- **Webhooks** - view registrations and delivery history
- **Channels** - manage Telegram and Discord integrations with pairing
- **MCP servers** - add, test, and remove Model Context Protocol servers
- **Provider management** - browse installed LLM providers and models

## Install

```bash
moxxy plugin install @moxxy/web-plugin
```

## Usage

```bash
# Start the dashboard
moxxy plugin start @moxxy/web-plugin

# Or use the interactive plugin menu
moxxy plugin
```

The dashboard opens at `http://localhost:17900`. Navigate to **Settings** to configure your gateway URL and API token if they aren't injected automatically.

## Development

Requires Node.js 22+ and npm.

```bash
git clone <repo>
cd web-plugin
npm install
npm run dev
```

The dev server starts on port 17900 with a proxy that forwards `/v1/*` requests to the gateway at `localhost:3000`.

### Build

```bash
npm run build
```

Produces a production bundle in `dist/`.

### Preview production build

```bash
npm run plugin:start
```

Serves the built `dist/` directory using a zero-dependency static server.

## How it works

The plugin is a single-page application built with [Ripple](https://www.ripple-ts.com/). At runtime it ships only pre-built static assets and a lightweight Node.js file server (`serve.js`) - no build tools or framework dependencies are required.

When started by the Moxxy CLI, the plugin receives environment variables (`MOXXY_API_URL`, `MOXXY_TOKEN`, `PORT`) and serves the dashboard on the allocated port. The dashboard communicates with the gateway entirely through its public REST API and SSE event stream.

## Environment variables

Set automatically when launched via `moxxy plugin start`:

| Variable | Description |
|---|---|
| `MOXXY_API_URL` | Gateway base URL (e.g. `http://localhost:3000`) |
| `MOXXY_TOKEN` | API bearer token |
| `PORT` | Port to serve the dashboard on |
| `MOXXY_PLUGIN_NAME` | Plugin package name (`@moxxy/web-plugin`) |
| `MOXXY_PLUGIN_PORT` | Allocated port (same as `PORT`) |
| `MOXXY_HOME` | Moxxy data directory (default `~/.moxxy`) |
| `VITE_MOXXY_API_URL` | Gateway URL exposed to browser code during development |
| `VITE_MOXXY_TOKEN` | API token exposed to browser code during development |

## Links

- [Documentation](https://docs.moxxy.ai)
- [Website](https://moxxy.ai)
- [GitHub](https://github.com/moxxy-ai/moxxy)

## License

Dual-licensed under [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE) at your option.