JoinGrove Documentation

Source: https://github.com/codebwoy/joingrove
Generated: 01/09/2026

Central documentation index for JoinGrove — agent-first IDE for the Global South.

Browse topics in-app: Command Palette → Browse JoinGrove Documentation Topics (joingrove.openDocsTopic)

Customize hub (sidebar nav + preview): Command Palette → Open JoinGrove Customize Hub (joingrove.openCustomizeHub) — or /customize in Agents chat.

Migrating from Cursor or Copilot? Open the Capabilities matrix (joingrove.openCapabilitiesMatrixDocs) — what JoinGrove ships natively vs upstream.

Table of Contents

Overview

• Agent platform overview — Agents, rules, MCP, skills & CLI
• Customize (Studio & Market) — language packs, stack templates, campus onboarding
• Rules & agent instructions — .cursor/rules, AGENTS.md, copilot-instructions
• Capabilities matrix — JoinGrove vs upstream support table
• Studio flow — Studio vs Classic, idea → publish
• Project README — development quick start, branding, license

Get Started

• Install guides — also in offline tutorials (joingrove.openInstallGuide)
• Install on macOS
• Install on Windows
• Install on Linux
• Install on Chromebook
• Install as PWA
• Your First Project with JoinGrove Campus
• Building from source — upstream VS Code compile guide

Integrations

• GitHub — Git, Copilot auth, zero egress
• Ollama — local models, BYOK setup
• Mobile money — M-Pesa, Paystack, stack template
• Docker campus — bootcamp lab image
• Set Up Offline AI with Ollama
• Mobile Money API Integration

Models

• Models overview — Ollama, Copilot BYOK, PPP tiers
• Copilot BYOK — bring your own key + local models
• Offline model routing — egress, adaptive tiers, security modes
• Offline vs cloud comparison
• Offline AI providers — Ollama models, RAM tiers
• PPP pricing tiers

Agent

• Agents window — default UI, multi-session orchestration
• Prompting & context — @ files, rules, AGENTS.md
• Studio wizard flow — idea → template → preview → publish
• Agent workflow guide — Git + agent patterns
• Chat slash commands — /studio, /docs, /hub
• Run in the Browser (Chromebook)

Global South

• Global South overview — PPP, locales, tutorials
• Ambassador program
• Adaptive performance profiles
• Global South hub — in-app pricing, mobile money
• Share via WhatsApp & Telegram
• Governance data · Ambassadors · PPP tiers

Self-Hosted & Campus

• Self-hosted campus — Docker, REH, setup script
• Remote tunnel — joingrove tunnel CLI
• Campus & REH agents — shared agent sessions
• Self-Hosted Campus Server
• Network egress policy — allowed vs blocked hosts
• Run modes — Local / REH / Web / Tunnel / PWA / Campus Docker

Account & Billing

• Account & billing — PPP checkout, Team tier, billing stub
• Billing server — npm run billing-server

CLI

• JoinGrove CLI — joingrove tunnel, server, workspace commands

Enterprise

• Enterprise & governance — zero egress, telemetry transparency, advisory board

Reference tables (generated)

• Agent commands — all joingrove.* Command Palette IDs
• Feature comparisons — Studio vs Classic, cloud vs offline
• Bundled locales — MS packs + African community l10n
• Stack templates — WordPress, Laravel, Flutter, mobile money, govtech
• Doc page template — standard 5-block structure for new pages

Regenerate reference tables: npm run generate-docs-reference · Verify: npm run verify-docs

Key Concepts

• Agent-first: JoinGrove opens the Agents window by default (defaultWindow: "agents" in product.json).
• Studio vs Classic: Studio is idea → template → publish; Classic is the full VS Code workbench (--classic).
• Offline-first: Local Ollama models, zero egress mode, and bundled offline extensions — no cloud subscription required.
• Global South: PPP pricing, African locales, mobile money, adaptive performance, and offline tutorial distribution.
• Run anywhere: Desktop, browser, REH server, tunnel, PWA, and self-hosted campus Docker.

API / Reference

In-app documentation commands

Command Palette IDs (common)

Pricing tiers (PPP comparison)

Source: resources/global-south/pricing-tiers.json · In-app: joingrove.showPricing

Setup & Installation

1. Clone the repository and install dependencies: npm install
2. Launch development build: npm run dev (Agents window) or ./scripts/code.sh --classic
3. Run verification: npm run verify-branding && npm run verify-global-south && npm run verify-docs
4. Optional — set up offline AI: npm run setup-offline-ai
5. Optional — start billing stub: npm run billing-server

Code Examples

# Development
npm install
npm run dev

# Verify productization
npm run verify-market-customization
npm run verify-global-south
npm run verify-docs

# Offline AI
npm run setup-offline-ai

# Self-hosted campus (Docker)
docker compose -f docker/campus/docker-compose.yml up -d

Visual design

JoinGrove docs use a dark-first layout with grove green accents (#2d8659):

Machine-readable tokens: resources/docs/docs-tokens.json
Stylesheet: resources/docs/docs-theme.css
Workbench hub UI (Studio home, Global South hub): src/vs/workbench/contrib/joingrove/browser/media/joingrove-docs-ui.css (.docs-root)
Browser/PWA landing: resources/docs/pwa-hub.html — in-app joingrove.openDocsPwaHub

How It Connects

• README → day-to-day development and feature overview
• Studio flow → first-run chooser and publish roadmap
• Global South tutorials → offline distribution via WhatsApp, Telegram, or USB
• Stack templates → agent rules and scaffolds created by joingrove.createStackProject
• In-app hub → joingrove.globalSouthHub surfaces pricing, tutorials, and ambassadors
• Topic browser → joingrove.openDocsTopic quick-picks from resources/docs/docs-index.json