whatisgithub

What is homekb?

do-md/homekb — explained in plain English

Analysis updated 2026-05-18

2TypeScriptAudience · developerComplexity · 3/5Setup · moderate

In one sentence

A local-first Markdown knowledge base that AI assistants can search and edit through a standard connector, while your notes stay on your own computer.

Mindmap

mindmap
  root((repo))
    What it does
      Indexes local Markdown notes
      Answers questions with citations
      Lets AI read and edit notes
    Tech stack
      Rust engine
      TypeScript client
      Cloudflare Workers relay
    Use cases
      Search personal notes by meaning
      Ask an AI questions about your notes
      Access your notes from your phone
    Audience
      Note takers using AI tools
      Privacy conscious users
    Access
      Files stay local
      Relay never stores content

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Turn a folder of Markdown notes into a semantic search index on your own computer.

USE CASE 2

Ask an AI assistant questions about your notes and get answers with citations.

USE CASE 3

Let Claude Code, Codex, or ChatGPT search and edit your notes through MCP.

USE CASE 4

Access and manage your notes remotely from your phone without an account.

What is it built with?

RustTypeScriptCloudflare WorkersMCP

How does it compare?

do-md/homekb4ssh1/mine-sweeperachawla19/intuitcode-extension
Stars222
LanguageTypeScriptTypeScriptTypeScript
Last pushed2026-01-31
MaintenanceMaintained
Setup difficultymoderatemoderatemoderate
Complexity3/52/54/5
Audiencedevelopervibe coderdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Automatic background-service installation for scheduled compilation is currently macOS-only.

No license information was stated in the README.

So what is it?

HomeKB turns a folder of plain Markdown notes on your own computer into a searchable knowledge base that AI tools can read and use, without ever moving your notes into someone else's cloud. You keep writing ordinary text files, and a small engine running locally builds a search index from them, so you can find notes by meaning rather than exact wording, ask questions about your notes and get answers backed by citations to the actual files, and let AI assistants like Claude or ChatGPT search, read, and update your notes directly. The system is made of three separate pieces. The engine is the core program that does the actual work: reading your Markdown files, building the search index, answering questions, and talking to AI tools through a standard connector protocol. The client is a single interface built once and shown two ways, as a plain website and as a native desktop app for Mac. The relay is what lets your phone or a browser somewhere else reach the engine running on your home computer, but it only passes messages back and forth and never stores your actual notes. Getting started means installing the engine on your computer through a package manager or install script, then running a single pairing command that generates a short lived code. You enter that code on a companion website from your phone or another browser to finish setup, after which that device can search, read, and edit your notes remotely while the files themselves never leave your home machine. You also have the option to skip the browser setup entirely and configure and use everything from the command line instead. Once connected, HomeKB gives any compatible AI assistant a consistent set of tools for searching, reading, creating, updating, listing, and sharing your notes. It also lets you create shareable public links to individual notes, with optional passwords and expiry dates, while keeping any notes you have not chosen to share private on your own device.

Copy-paste prompts

Prompt 1
Walk me through installing HomeKB and pairing my phone with it.
Prompt 2
Explain how HomeKB's engine, client, and relay pieces work together.
Prompt 3
Show me how to connect an MCP-compatible AI assistant to my HomeKB notes.
Prompt 4
Help me set up scheduled reindexing so my notes stay searchable automatically.

Frequently asked questions

What is homekb?

A local-first Markdown knowledge base that AI assistants can search and edit through a standard connector, while your notes stay on your own computer.

What language is homekb written in?

Mainly TypeScript. The stack also includes Rust, TypeScript, Cloudflare Workers.

What license does homekb use?

No license information was stated in the README.

How hard is homekb to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is homekb for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.