skip to content
MusesΜοῦσαιdocs

basics / 02 of 13

Installing

kyma is one Go binary. Install it with Go, and check it runs with the tour deck it carries.

Requirements

  • Go 1.26 to build it.
  • A terminal with true colour. Any modern one will do: Kitty, WezTerm, Ghostty, iTerm2, Alacritty, GNOME Terminal, Windows Terminal.
  • For pixel images, a terminal that speaks the Kitty graphics protocol, iTerm2’s protocol or sixel. Everywhere else images are drawn in coloured symbols. kyma detects which by itself.

With Go

shell
go install github.com/museslabs/kyma@main

Checking it works

shell
kyma docs

kyma docs plays the tour deck built into the binary, which is a quick way to see every transition and a grid on your own terminal.