Wiremaven package, CLI, and Chrome extension reference

wiremaven has three entry points: package integration inside the project, explicit terminal control through the CLI, and a Chrome extension that leaves the project untouched. This page covers the package and CLI surfaces. The extension-specific guide covers the popup workflow and privacy model.

Choose a workflow path #

Pick the path that matches how much control you want over the project and where you want to operate the tunnel.

Package installation #

Install wiremaven as a dev dependency when you want the project-integrated path. Supported frameworks: Vite, Astro, Next.js, Webpack, and Rspack. No global binary needed.

npm install -D wiremaven

Or using other package managers:

pnpm add -D wiremaven
yarn add -D wiremaven

Package quickstart #

Run the setup wizard once to let wiremaven detect your framework and add the right integration:

npx wiremaven init

The wizard inspects your package.json and framework config files, then patches the relevant config to add the wiremaven overlay plugin. The wizard refuses risky rewrites and leaves manual fallback guidance when it does not recognize the config shape.

Start the dev server

Run your existing dev command as normal. wiremaven hooks in during startup:

npm run dev

When the session is active, the overlay widget shows the public URL and session status to anyone loading the page, including the viewer. The agent logs the relay registration to stderr as structured JSON; the local control API is reachable at http://127.0.0.1:2999 by default.

Share the public URL

Copy the tunnel URL from the overlay widget and send it to whoever needs to review the build. The viewer sees your live local build through the relay. In the package path, the overlay widget appears in the viewer's browser and shows the session status, viewer count, and a countdown to expiry. The Chrome extension path keeps session state in the popup and does not modify the reviewed page.

Package commands #

The wiremaven package exposes CLI commands for setup, diagnostics, and teardown. These run against the project in the current directory:

Configuration #

npx wiremaven init patches your framework config during setup, so most projects do not need hand-edited plugin options. When you customize behavior, pass options to the integration function for your framework. The import and placement differ per framework:

Example for Vite (vite.config.ts):

import { wiremavenOverlay } from "wiremaven";

export default defineConfig({
  plugins: [
    wiremavenOverlay({
      expiresInSeconds: 1800,  // 900 (15m) | 1800 (30m) | 3600 (60m)
      sessionName: "my-demo", // optional tunnel label
      relayBaseUrl: undefined, // override relay endpoint (optional)
      autoStartAgent: true,   // set false to start the tunnel manually
    }),
  ],
});

wiremaven-cli reference #

The wiremaven-cli package starts a relay session from the terminal without touching your project. Use it for unsupported frameworks, CI environments, or any case where you want explicit control over when the tunnel opens. The command takes a local port number and accepts optional flags:

npx wiremaven-cli <port> [options]

For example, to share a server on port 3000 with a 30-minute window:

npx wiremaven-cli 3000 --expires 30m --name my-demo

The terminal prints the public URL once the relay is ready:

Wiremaven tunnel ready: https://relay.wiremaven.com/p/building-canvas-3827/
Local control API: http://127.0.0.1:2999

Press Ctrl+C to close the session.

Options and flags #

All flags apply to npx wiremaven-cli <port>:

How it works #

All wiremaven paths use the same relay between your local dev server and the public URL. A viewer loads the shared URL, and the relay proxies their requests to your machine through an encrypted WebSocket channel. Overhead on the critical path stays under 200ms.

With the package path, wiremaven injects the overlay widget into the viewer's page. It subscribes to the same event stream and surfaces viewer connections, request outcomes, and failures. The Chrome extension uses that event stream in the popup and leaves the reviewed page untouched.

Sessions are time-bounded. At expiry, the public URL stops accepting new connections and the relay closes.

Session model #

Every relay session has a fixed window from the moment it starts. The available windows are 15 minutes, 30 minutes (default), and 60 minutes.

At expiry:

• The public URL stops accepting new connections.
• The relay closes the channel and clears the session record.
• The relay retains no viewer data after expiry.

You cannot extend a session once it starts. Stop the current one and run the CLI again with the --expires value you want.