The Kalem Book GitHub

This Book describes Kalem's main branch, which may be ahead of the latest release.

Installing

From a release, on macOS and Linux:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/getkalem/kalem/releases/latest/download/kalem-editor-installer.sh | sh

and on Windows, in PowerShell:

powershell -ExecutionPolicy Bypass -c "irm https://github.com/getkalem/kalem/releases/latest/download/kalem-editor-installer.ps1 | iex"

The installers put kalem in ~/.cargo/bin (the archives they unpack, one for each of macOS on Apple silicon and Intel, Linux on x86-64 and ARM, and Windows on x86-64, are on the releases page with a .sha256 beside each); delete it there to uninstall. Each release also has terminal-only archives, kalem-terminal-TARGET: the terminal editor and the command-line tools without the graphical editor, the viewers of PDF files, pictures and workbooks, and plugins. On Linux the full binary links the windowing libraries (xkbcommon, Wayland, X11, fontconfig, freetype, Vulkan) even for kalem tui, so a server should take the terminal archive; both need glibc 2.35 or later (Ubuntu 22.04).

Or build it from source with Rust 1.96 or later:

git clone https://github.com/getkalem/kalem && cd kalem
cargo install --locked --path crates/kalem
# Terminal editor and command-line tools only:
cargo install --locked --path crates/kalem --no-default-features --features tui

Both put one program, kalem, in Cargo's bin folder, which is on your PATH when Rust came with rustup.

Linux
the graphical editor needs the development files of xkbcommon, Wayland, X11 (xcb), fontconfig, freetype and Vulkan; on Debian and Ubuntu, libxkbcommon-dev libxkbcommon-x11-dev libwayland-dev libx11-xcb-dev libxcb1-dev libfontconfig-dev libfreetype-dev libvulkan-dev. The terminal-only build needs none of them.
macOS
nothing more. tools/macos-app.sh builds Kalem.app; it is not signed, so the first time, open it with right-click and Open.
Windows
Rust with its MSVC tools, nothing more. The settings live in %APPDATA%\kalem.

No release has a plugin built in: the viewers of PDF files, pictures and workbooks are installed the first time such a file is opened, or with kalem plugin install. The terminal-only build leaves out the graphical editor, and with it the plugin host, which weighs some 10 MB: files that are not text are refused, and installed plugins do not run. Name it to keep it (plugins; components builds the viewers in too, downloaded from the releases of getkalem/plugins, for a build of your own that must open them without installing):

cargo install --locked --path crates/kalem --no-default-features --features tui
cargo install --locked --path crates/kalem --no-default-features --features tui,components