JoinGrove

Quickstart

Source: docs/get-started/quickstart.md
Generated: 01/09/2026

Get JoinGrove running in minutes — agent-first by default, Classic IDE one flag away.

Key Concepts

  • What: Clone, install dependencies, launch the Agents window, and verify productization scripts pass.
  • Why: Every campus cohort and contributor needs the same baseline before Studio, offline AI, or self-hosted campus setup.
  • Related: Per-platform install guides in this folder, full README (README.md), documentation hub (../README.md).

API / Reference

Step Command / ID Outcome
Install deps npm install Node modules + native builds
Launch Agents npm run dev Default Agents window
Classic IDE ./scripts/code.sh --classic VS Code-style workbench
Verify branding npm run verify-branding Product identity checks
Docs hub joingrove.openDocsHub In-app documentation index
Choose build mode joingrove.chooseBuildMode Studio vs Classic

Keyboard shortcuts (Agents chat)

Input Action
Enter Send message immediately
Shift+Enter New line in the input (no send)
/ Open slash command picker (/studio, /hub, /matrix, …)

Prerequisites

Requirement Version
Node.js 24.13.0+ (see .nvmrc)
npm < 13
Python 3 Native module builds
OS macOS, Linux, or Windows

Setup & Installation

  1. Clone the repository and cd into the project root.
  2. Run npm install — wait for native module compilation.
  3. Run npm run dev — JoinGrove opens the Agents window.
  4. Command Palette → Choose How You Want to Build… (joingrove.chooseBuildMode) on first launch.
  5. Run verification scripts (see Code Examples).

Code Examples

git clone https://github.com/codebwoy/joingrove.git
cd joingrove
npm install
npm run dev

Verify setup:

npm run verify-branding
npm run verify-agent-first
npm run verify-global-south

Optional — offline AI:

npm run setup-offline-ai

Next: Pick a per-platform install guide (install-macos.md, install-windows.md, etc.) or open Open JoinGrove Documentation Hub (joingrove.openDocsHub).

How It Connects