Installation

English · Русский

The familiar helper wires everything into kitty for you: it writes an include into your kitty.conf and generates the kitten maps with absolute paths (kitty resolves a relative kitten path from ~/.config/kitty, not from the file that maps it — so the path can't just be relative). No manual editing, no sed, and it survives updates.

Homebrew (recommended)

brew tap denoby/familiar https://github.com/DenoBY/familiar
brew install denoby/familiar/familiar   # full name = trust just this formula
familiar enable --all                    # kittens + the terminal config

The full name denoby/familiar/familiar is required by Homebrew 6.0+ Tap Trust: third-party taps aren't loaded until trusted, and a fully-qualified install trusts only this formula. Alternatively trust the whole tap once with brew trust denoby/familiar, then brew install familiar works bare.

Bleeding edge from master: brew install --HEAD denoby/familiar/familiar.

From a clone (no Homebrew)

git clone https://github.com/DenoBY/familiar && cd familiar
./bin/familiar enable --all

Same command either way. Then reload the config — Cmd+Ctrl+, — or restart kitty. (Ctrl+Shift+F5 is kitty's Linux reload default; on macOS it's Cmd+Ctrl+,.)

Install modes

Pick how much to wire in:

Command	What it enables
familiar enable --all	all kittens + the terminal config (look, splits, tabs, Russian layout) — asks first, since it overrides your kitty settings
familiar enable --kittens	all kittens only, leaves your terminal config untouched
familiar enable session review log	only the named overlays (add --terminal for the terminal config too)
familiar enable --terminal	only the terminal config, no kittens
familiar enable --all --theme darcula	same as --all, but with the Darcula palette (JetBrains) instead of the default one — see Themes
familiar disable	remove the familiar block (--restore reverts kitty.conf from the backup taken on first enable)
familiar status	show what's currently enabled

Cyrillic key duplicates (S→ы, R→к, L→д) for the Russian layout are generated automatically.

Uninstall / rollback

familiar only ever adds a fenced block to your kitty.conf and writes a familiar.conf beside it — nothing else is touched, so removal is clean:

familiar disable            # drop the familiar block + familiar.conf
familiar disable --restore  # ...and restore kitty.conf from the backup

On the first enable, familiar copies your kitty.conf once to kitty.conf.familiar.bak (the pre-familiar state). --restore puts it back byte-for-byte; the .bak stays afterwards, so you can restore later too. familiar status shows where it lives.

Prefer to do it by hand? Delete the block between the # >>> familiar >>> / # <<< familiar <<< markers in kitty.conf, remove familiar.conf, or just copy kitty.conf.familiar.bak back over kitty.conf.

Open with Cmd+Shift+S / Cmd+Shift+R / Cmd+Shift+L.