gbrain-cli

Files (1)

• SKILL.md

SKILL.md (first lines)

# GBrain CLI

## Overview

GBrain is a local CLI plus a local SQLite database, not a hosted web service.

The stable mental model is:

- binary: `gbrain`
- data file: `brain.db`
- MCP entrypoint: `gbrain serve --db /absolute/path/to/brain.db`

If someone says "deploy GBrain", translate that into one of three jobs:

1. install the binary locally
2. initialize or use a local `brain.db`
3. connect an MCP client to `gbrain serve`

Primary repo docs:

- [`README.md`](/Users/x/Desktop/Project/GBrain/README.md)
- [`DEPLOYMENT.md`](/Users/x/Desktop/Project/GBrain/DEPLOYMENT.md)

## When to Use

Use this skill when someone asks how to:

- install `gbrain`
- deploy it locally
- initialize a new brain
- configure OpenAI or OpenRouter embeddings
- connect GBrain to Claude Code, Codex, or OpenClaw
- upgrade the installed binary
- troubleshoot local CLI or MCP setup

Do not use this skill for schema design, search ranking, or migration debugging inside the repo. That is code work, not operator guidance.

## Quick Start

From source:

```bash
git clone https://github.com/laozhong86/gbrain.git
cd gbrain

bun install
bun run check
bun test
bun run build
```

Install the binary into PATH:

```bash
mkdir -p ~/.local/bin
cp bin/gbrain ~/.local/bin/gbrain
chmod +x ~/.local/bin/gbrain
```

Recommended local data path:

```bash
mkdir -p ~/.gbrain
gbrain init ~/.gbrain/main.db
gbrain stats --db ~/.gbrain/main.db
```

OpenClaw-specific preset:

```bash
export GBRAIN_PROFILE=openclaw
gbrain init
gbrain stats
```

That preset resolves the default database path to `~/.openclaw/brain.db` while keeping the generic CLI behavior unchanged for everyone else.

Minimum smoke checks:

```bash
gbrain version
gbrain --tools-json
gbrain stats --db ~/.gbrain/main.db
```

## Embeddings

Lexical search works without any model key:

```bash
gbrain search "Jensen Huang" --db ~/.gbrain/main.db
```

Embeddings and hybrid query require a provider key.

OpenAI:

```bash
export OPENAI_API_KEY=your_key
```

OpenRouter:

```bash
export OPENROUTER_API_KEY=your_key
export OPENROUTER_HTTP_REFERER=https://your-site.example
export OPENROUTER_X_TITLE=GBrain
```

Current provider behavior:

- if `OPENAI_API_KEY` exists, use OpenAI
- if only `OPENROUTER_API_KEY` exists, use OpenRouter
- `EMBEDDING_BASE_URL` or `OPENAI_BASE_URL` can override the embeddings endpoint

Typical verification:

```bash
gbrain embed --all --db ~/.gbrain/main.db

From laozhong86/gbrain, MIT.

More from laozhong86/gbrain