Shore is a TUI (terminal user interface) framework following The Elm Architecture for Gleam.
It is purely focused on the erlang runtime.
Shore requires erlang/otp 28 at minimum.
Further documentation can be found at https://hexdocs.pm/shore.
Check out the examples directory for more information and showcase of features such as commands, layout and styling
gleam add shore@1import gleam/erlang/process
import gleam/int
import gleam/option.{Some}
import shore
import shore/key
import shore/layout
import shore/style
import shore/ui
// MAIN
pub fn main() {
let exit = process.new_subject()
let assert Ok(_actor) =
shore.spec(
init:,
update:,
view:,
exit:,
keybinds: shore.default_keybinds(),
redraw: shore.on_timer(16),
)
|> shore.start
exit |> process.receive_forever
}
// MODEL
pub opaque type Model {
Model(counter: Int)
}
fn init() -> #(Model, List(fn() -> Msg)) {
let model = Model(counter: 0)
let cmds = []
#(model, cmds)
}
// UPDATE
pub opaque type Msg {
Increment
Decrement
}
fn update(model: Model, msg: Msg) -> #(Model, List(fn() -> Msg)) {
case msg {
Increment -> #(Model(counter: model.counter + 1), [])
Decrement -> #(Model(counter: model.counter - 1), [])
}
}
// VIEW
fn view(model: Model) -> shore.Node(Msg) {
ui.box(
[
ui.text(
"keybinds
i: increments
d: decrements
ctrl+x: exits
",
),
ui.text(int.to_string(model.counter)),
ui.br(),
ui.row([
ui.button("increment", key.Char("i"), Increment),
ui.button("decrement", key.Char("d"), Decrement),
]),
],
Some("counter"),
)
|> ui.align(style.Center, _)
|> layout.center(style.Px(50), style.Px(12))
}The following terminal emulators have been tested and are generally supported. It is expected any modern terminal emulator should work.
Shore makes use of the terminal CSI 2026 Synchronized Output to aid smoothing the redrawing experience and also alt buffers.
- alacritty
- ghostty
- wezterm
- kitty
- iterm2
- warp
- konsole
- gnome-console
- st
- window terminal
- Terminal.App (layout issues?)
- tmux with alacritty (flickering under certain conditions, debug help wanted!)