Get started.

From install to first session in under 2 minutes. No account required for local use.

Installation

NPM (Recommended)
$ npm install -g @ginkoai/cli

Requires Node.js 18+

Verify Installation
$ ginko --version

Should print version number

Quick start

1

Initialize in your project

terminal
$ cd your-project
$ ginko init
✓ Initialized ginko in .ginko/
✓ Created CLAUDE.md with project instructions
→ Run 'ginko start' to begin your first session

Creates .ginko/ directory and CLAUDE.md for AI instructions.

2

Start a session

terminal
$ ginko start
✓ Session started
→ Context loaded (0 events)
Ready | Cold (0/10) | Think & Build mode
What would you like to work on?

First session is "cold" - it warms up as you work and capture context.

3

Work and capture insights

terminal
$ ginko log "Fixed auth bug - was missing token refresh"
✓ Event logged
$ ginko log "Pattern: always validate tokens on API routes"
✓ Event logged

Log insights, decisions, and patterns as you work. They'll surface in future sessions.

4

Resume tomorrow

terminal (next day)
$ ginko start
✓ Session restored from yesterday
→ Loaded 12 events
Ready | Warm (4/10) | Think & Build mode
Resume: Fixed auth bug, implemented token refresh
What would you like to work on?

Your AI now knows your recent context. No re-explaining needed.

Essential commands

ginko init

Initialize ginko in a project. Creates .ginko/ and CLAUDE.md.

ginko start

Start or resume a session. Loads context and shows resume point.

ginko log "..."

Capture an insight, decision, or achievement. Surfaces in future sessions.

ginko handoff "..."

Create a session summary for clean transitions between sessions.

ginko charter

Create a project charter with AI guidance. Defines goals and success criteria.

ginko --help

See all available commands and options.

Unlock more with Pro

Pro $9/user/mo
  • ✓ Cloud backup & sync
  • ✓ Team context sharing
  • ✓ Natural language project queries
  • ✓ Knowledge graph visualization
  • ✓ Priority email support
Start Pro Trial

Enable cloud sync

terminal
$ ginko login
→ Opening browser for authentication...
✓ Logged in as chris@example.com
$ ginko graph init
✓ Knowledge graph created
✓ Cloud sync enabled

Events sync automatically. Access your context from any machine.

Next steps

FULL_DOCS

Complete documentation with advanced features and configuration.
ARCHITECTURE

Learn how ginko stores and surfaces context under the hood.
FOR_DEVELOPERS

Deep dive into developer workflows and productivity features.
FOR_TEAMS

Team context sharing, onboarding, and collaboration features.
Copied!