Docs/Getting Started/Quick Start
SECTION 01Getting Started

Quick Start Guide

LMESH enables developers to share their local terminal session with collaborators directly through any modern web browser. Follow this guide to install the CLI, authenticate with GitHub, and launch your first live session.

STEP 01

Prerequisites

Before getting started, make sure your local workstation meets the following runtime requirements:

Host Environment

Node.js 20.x or newer installed on macOS, Linux, or Windows (PowerShell / Windows Terminal with ConPTY).

Collaborator Browser

Zero installations required. Collaborators join via any modern browser (Chrome, Firefox, Safari, Edge).

STEP 02

Installation

Install the CLI globally from the npm registry using your package manager of choice, or run directly via npx:

Package: lmesh-cli
npmjs.com/package/lmesh-cli
$npm install -g lmesh-cli

Installing lmesh-cli exposes both lmesh and lmesh-cli binary commands globally in your PATH. Verify installation with lmesh --version.

STEP 03

Authentication

LMESH uses the GitHub OAuth Device Flow for easier passwordless CLI authorization. You don't need to manually create or copy personal access tokens.

bash
$lmesh login
What happens when you run this command:
  1. The CLI generates a unique 8-character verification code (e.g. XXXX-YYYY).
  2. Your browser automatically opens GitHub's device activation page.
  3. Enter the one-time code and click Authorize.
  4. The CLI automatically detects approval and writes your session token to ~/.lmesh/auth.json.
STEP 04

Starting Your First Session

Once authenticated, share your active shell session with a single command:

bash
$lmesh share
terminal preview
$lmesh share
Authenticated as @octocat
Connecting to relay server...
Session created successfully!
Share this link with collaborators:
https://lmesh.vercel.app/x7k2m9p
(Type 'exit' or press Ctrl+] to end session • Ctrl+S for Private Mode)
Private Mode is Built-in

Pressing Ctrl+S anytime during your session toggles Private Mode. When enabled, sensitive commands and credentials such as database passwords, API tokens, and JWTs are dynamically redacted from the web audit log and collaborator streams.

Section 1 of 4 completed
Next: CLI Reference