songsee/docs/install.md
Peter Steinberger 5cee6499fe
docs: rewrite site gogcli-style with per-feature pages
Drop the custom Jekyll layout, CSS, and JS in favor of GitHub Pages'
default theme — same approach gogcli.sh uses. Replace the marketing
landing page with a plain-markdown overview that mirrors gogcli's
"try it / what it does / pick your path" structure.

Add one focused page per feature: install, quickstart, visualizations,
palettes, decoding, rendering, pipeline (spec), and CLI reference.
Verify ffmpeg pipeline (f32le) and decoder coverage against the actual
audio package.
2026-05-08 16:01:45 +01:00

1.7 KiB

title description
Install Install songsee via Homebrew, go install, or build from source.

Install

songsee ships as a single Go binary. Pick whichever delivery mechanism fits.

Homebrew (macOS, Linux)

brew install steipete/tap/songsee
songsee --version

The formula lives in steipete/homebrew-tap. brew upgrade songsee brings in new releases.

go install

go install github.com/steipete/songsee/cmd/songsee@latest
songsee --version

This builds against the Go version declared in go.mod. The binary lands in $(go env GOBIN) (or $(go env GOPATH)/bin).

Build from source

git clone https://github.com/openclaw/songsee.git
cd songsee
make
./songsee --version

make runs go build with the version string injected from git describe.

ffmpeg (optional)

WAV and MP3 decode natively in pure Go. Anything else (FLAC, AAC, OGG, M4A, video containers) falls through to ffmpeg on PATH.

brew install ffmpeg          # macOS / Linuxbrew
apt install ffmpeg           # Debian / Ubuntu

Override the lookup with --ffmpeg /custom/path/ffmpeg when you have several builds installed.

Verify the install

songsee --version
songsee --help
songsee testdata/short.wav   # render a tiny known-good file

Updating

  • Homebrew: brew upgrade songsee.
  • go install: rerun go install github.com/steipete/songsee/cmd/songsee@latest.
  • Source: git pull && make — version comes from git describe.
  • Quickstart — first render in under a minute.
  • Decoding — WAV/MP3 fast paths and ffmpeg fallback.
  • CLI — every flag with its default.