Documentation

Updated 13 Oct 2026

Welcome

What Kribble is, and where to start in these docs

Kribble is a knowledge base you run yourself. Notes live in spaces and folders, are written in a rich editor that also speaks markdown, and can be published as documentation sites, exported as PDFs, and read and written by AI agents and from the terminal.

These docs have two parts: one for everyone who writes and reads in Kribble, and one for the people who run the server.

  • Using Kribble: signing in, writing and organising notes, search, comments, sharing, publishing, PDFs, the desktop app, the CLI and AI agents.

  • Running a server: installing, configuring, sign-in and access, publish targets, downloads, backups and troubleshooting.

Where to start

About these docs

This documentation is itself kept in git and pushed to Kribble with the CLI. To put it on your own server, clone the repository, set the target folder in docs/kribble.toml, and push:

kribble login --server https://kribble.example.com
kribble push docs

The pushed folder is read-only in Kribble (comments still work); change the files in the repository and push again. To publish it as a site:

kribble deploy "Kribble/Documentation"