Skip to content

Fastest way to scaffold your LLM powered personal knowledge base - Obsidian, Claude Code, qmd, Github

1.4 KB
Raw Blame
# GitHub remote

GitHub is the default Git backend for claude-second-brain. Your vault is stored as a private GitHub repository — you get version history, access from any device, and Obsidian mobile sync via the bundled Git plugin.

## Prerequisites

- A [GitHub account](https://github.com/join)
- [`gh` CLI](https://cli.github.com/) — used for authentication and repo creation during setup

## Setup (automatic)

When you run `npx claude-second-brain` and select **GitHub** as your remote, the CLI handles everything:

1. Checks `gh auth status` — runs `gh auth login` if not authenticated
2. Creates a private repo: `gh repo create <name> --private --source=. --remote=origin --push`
3. Pushes the initial commit

## Manual setup

If you skipped GitHub during setup, or `gh` wasn't installed, connect it manually:

```bash
# With gh CLI
gh repo create my-brain --private --source=. --remote=origin --push

# Without gh CLI
git remote add origin https://github.com/you/my-brain.git
git push -u origin main
```

## Syncing from Obsidian

The vault includes a pre-configured `.obsidian/` folder with [obsidian-git](https://github.com/Vinzent03/obsidian-git) settings. Enable the plugin in Obsidian → Community plugins and it will auto-commit and push on a schedule.

For iOS: place the repo folder inside iCloud Drive — Obsidian Mobile picks it up natively and obsidian-git handles sync.