Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

While this is in development you won't find this tool in package managers yet. Once that will be available we will mention it here:

Releases

Please check the Releases tab for download options and release notes.

Compiling from source

We use mise to manage our development tools. All you have to do to have exactly the same tools in exactly the right version is to follow the guide. The TL;DR is:

$ git clone https://github.com/open-sesam/sesam.git
$ mise install
$ task # `sesam` will be in the top-level dir - copy it where you want to.

This is also the best way to start working on sesam if you want to open a PR.

Alternatively, if you already have go installed:

# Replace @latest with a git tag of your choice.
# This will not contain the build version really though!
$ go install opensesam.org/sesam@latest

Docker

TODO: Docker images can be useful for CI pipelines, we already have a Dockerfile, but don't upload the image yet.

Changelog

The changelog is derived from our git history via git-cliff and can be viewed at CHANGELOG.md.

Versioning schema

We use semantic versioning:

$ sesam --version
0.1.2 [2fee38ca3] (2026-05-31) © 2026 Chris Pahl and contributors

First stable version

Warning

We will only guarantee stable interfaces (i.e. stable storage layout, stable API and backwards-compatible CLI) once we reach 1.0.0.

Right now, we can't tell you yet when this 1.0.0 release will be. It might go fast, it might as-well take a long time. This mostly depends on how sesam is used in the field and how much we feel we need to change it to keep up with reality.

However, after announcing the first test version to the world, we will think twice to change things around. We try to keep the repository layout stable and also the CLI concepts should mostly stay the same.

Built unknown • commit: