JoinGrove

JoinGrove CLI

Source: docs/cli/overview.md
Generated: 01/09/2026

The joingrove CLI provides tunnel, server, and workspace commands — built from the same product.json as the desktop app.

Key Concepts

  • What: CLI binaries ship with JoinGrove builds for headless server management, tunneling, and opening folders in the Agents window.
  • Why: Campus admins and CI pipelines need scriptable access without launching the full Electron shell.
  • Related: Tunnel (../self-hosted/tunnel.md), run modes (run-modes.md), campus (../self-hosted/campus.md).

API / Reference

Command Purpose
joingrove ./my-project Open folder in Agents window
joingrove tunnel Secure tunnel to local REH/web server
joingrove --classic Launch classic workbench (desktop)
joingrove --agents Explicit Agents window (default when agent-first)

npm scripts (development)

Script Purpose
npm run dev Launch Agents window from source
npm run server REH headless server
npm run sessions-web Agents UI in browser
npm run web Classic web workbench
npm run setup-self-hosted-server Campus server setup
npm run smoke-run-anywhere Smoke test server/tunnel/Ollama

Server config (joingroveRunAnywhere.serverCommands)

Key Command
reh npm run server
web npm run web
sessionsWeb npm run sessions-web

Setup & Installation

  1. Build JoinGrove from source (CLI is generated at compile time per product.json).
  2. Add the joingrove binary to your PATH (or use scripts/code.sh wrapper during dev).
  3. For tunnel → start server first, then joingrove tunnel.
  4. Command Palette → Choose How to Run JoinGrove… (joingrove.runAnywhereWizard) mirrors CLI workflows in the UI.

Code Examples

Open project in Agents window:

joingrove ./my-wordpress-site

Server + tunnel workflow:

npm run server
joingrove tunnel

Smoke test all run-anywhere modes:

npm run smoke-run-anywhere
npm run smoke-run-anywhere -- --check-ollama

Next: Deploy campus with setup-self-hosted-server for production CLI usage on a VM.

How It Connects