Home›Docs› Installation

Installation

Zeemist runs on macOS (Apple Silicon and x86-64), Linux (x86-64 and ARM64), and Windows via WSL. A native Windows binary is not currently planned.

Option 1 — Shell script (recommended)

The install script detects your platform, downloads the appropriate prebuilt binary from the GitHub releases page, verifies the SHA-256 checksum, and places the binary at /usr/local/bin/zeemist.

curl -sSL https://zeemist.cfd/install.sh | sh

If you prefer to inspect the script before running it (which is sensible), you can download and review it first:

curl -sSL https://zeemist.cfd/install.sh -o zeemist-install.sh
# read it
sh zeemist-install.sh

Option 2 — Cargo

If you already have the Rust toolchain installed, you can build from source via Cargo. This takes a minute or two on first run.

cargo install zeemist

Minimum supported Rust version (MSRV): 1.75. Older toolchains will produce a compile error pointing at the async trait bounds in src/fetch/mod.rs.

Option 3 — Prebuilt binary

Download the binary directly from the releases page and put it somewhere on your $PATH.

# macOS Apple Silicon
curl -sSL -o zeemist https://zeemist.cfd/releases/v0.4.2/zeemist-aarch64-apple-darwin
chmod +x zeemist && mv zeemist /usr/local/bin/

# macOS Intel
curl -sSL -o zeemist https://zeemist.cfd/releases/v0.4.2/zeemist-x86_64-apple-darwin
chmod +x zeemist && mv zeemist /usr/local/bin/

# Linux x86-64
curl -sSL -o zeemist https://zeemist.cfd/releases/v0.4.2/zeemist-x86_64-unknown-linux-musl
chmod +x zeemist && mv zeemist /usr/local/bin/

SHA-256 checksums are listed on the changelog page alongside each release.

Verify the install

zeemist --version
# zeemist 0.4.2 (a4f9c12 2026-04-28)

Shell completions

Generate completions for your shell and place the output file in the appropriate directory:

# bash
zeemist completions bash >> ~/.bash_completion

# zsh (add to fpath)
zeemist completions zsh > ~/.zfunc/_zeemist
echo "fpath=(~/.zfunc $fpath)" >> ~/.zshrc
autoload -U compinit && compinit

# fish
zeemist completions fish > ~/.config/fish/completions/zeemist.fish

Uninstall

Remove the binary and optionally the config and cache directories:

rm /usr/local/bin/zeemist
rm -rf ~/.config/zeemist ~/.cache/zeemist

Configuration file

On first run, Zeemist creates ~/.config/zeemist/config.toml with defaults. Here is the full annotated template:

[defaults]
# Output format: table, chart, or json
format = "table"

# How long fetched data stays valid before re-fetching (minutes)
cache_ttl_minutes = 30

# Units: metric (meters, °C) or imperial (feet, °F)
units = "imperial"

# Terminal colour support: auto, always, never
color = "auto"

[[profiles]]
# Short name used with --profile
name = "rodeo"
lat = 37.834
lon = -122.552
# NOAA station ID (required for tide predictions)
station = "9414290"

# Add more profiles as needed
# [[profiles]]
# name = "stinson"
# lat = 37.892
# lon = -122.644
# station = "9414290"  # closest gauge

← Back to overview