Skip to content
ginko

Getting Started

ginko is a CLI tool that gives your AI pair programming sessions memory, structure, and continuity. This guide walks you through installation, authentication, and your first session.

Steps

Section titled “Steps”
  1. Installation — Install the CLI from npm
  2. Authentication — Connect to ginko cloud (optional)
  3. Your First Project — Initialize ginko in a project
  4. Your First Session — Start, work, and handoff

Prerequisites

Section titled “Prerequisites”
  • Node.js 18 or later
  • npm 9 or later
  • A project directory (new or existing)
  • An AI coding assistant (Claude Code, Cursor, Copilot, etc.)

Architecture

Section titled “Architecture”

ginko operates in two layers:

  • Local — Session files, event logs, and sprint documents stored in .ginko/ and docs/. Works fully offline.
  • Cloud (optional) — Knowledge graph, semantic search, team sync, and dashboard. Requires authentication.

You can use ginko in local-only mode with full session management. Cloud features unlock the knowledge graph, team collaboration, and the web dashboard.