# Otter Shell

## Docs

- [otter-cal](https://docs.otter-shell.org/apps/otter-cal.md): Print a month grid and agenda list to stdout. Works with bar clock popovers and plain-text agenda files.
- [otter-calc](https://docs.otter-shell.org/apps/otter-calc.md): Evaluate math expressions from the terminal or launcher. Pass --copy to send the result to clipboard via otter-copy.
- [otter-clip](https://docs.otter-shell.org/apps/otter-clip.md): Clipboard manager with searchable history. Access entries via Super+V popup or CLI commands.
- [otter-emoji](https://docs.otter-shell.org/apps/otter-emoji.md): Search Unicode 17.0 emoji by name. Print matches, show a compact grid, or copy the first hit to clipboard.
- [otter-note](https://docs.otter-shell.org/apps/otter-note.md): Pin markdown notes to a layer-shell surface. Toggle with Super+N, edit inline, preview rendered markdown, save on exit.
- [otter-pick](https://docs.otter-shell.org/apps/otter-pick.md): Pick screen colors in hex, RGB, and OKLCH. Click to copy, or pass coordinates for scripted sampling.
- [otter-rec](https://docs.otter-shell.org/apps/otter-rec.md): Record your Wayland screen with hardware acceleration. Toggle with a hotkey, capture regions or windows, encode with NVENC, QSV, or VAAPI.
- [otter-screenshot](https://docs.otter-shell.org/apps/otter-screenshot.md): Capture regions, windows, or the full screen on Wayland. Drag to select, then copy to clipboard or save to a file.
- [otter-shot](https://docs.otter-shell.org/apps/otter-shot.md): Frame window screenshots with gradients, shadows, corner radius, and custom chrome. Export PNG to file or clipboard.
- [otter-term](https://docs.otter-shell.org/apps/otter-term.md): Native Wayland terminal for Otter Shell. Tabs, split panes, shell integration, URL handling, and IME support.
- [otter-timer](https://docs.otter-shell.org/apps/otter-timer.md): Count down a duration and get a desktop ping when it finishes. Flexible duration strings, custom messages, and completion commands.
- [otter-transcribe](https://docs.otter-shell.org/apps/otter-transcribe.md): Transcribe microphone audio on-device via PipeWire. Requires the otter-shell-extras metapackage.
- [otter-vox](https://docs.otter-shell.org/apps/otter-vox.md): Convert text to speech on-device with an embedded Kokoro TTS model. Requires the otter-shell-extras metapackage.
- [otter-weather](https://docs.otter-shell.org/apps/otter-weather.md): Fetch current conditions and a 7-day forecast from Open-Meteo. Feed the bar widget, open a popup, or print to stdout.
- [Keybinds](https://docs.otter-shell.org/configuration/keybinds.md): In-app shortcuts for Otter Shell apps, plus compositor global hotkey examples for Hyprland, Sway, and other Wayland compositors.
- [Configuration overview](https://docs.otter-shell.org/configuration/overview.md): Configure Otter Shell in otter-settings or by editing ~/.config/otter-shell/. Most changes hot-reload on save.
- [Themes and colors](https://docs.otter-shell.org/configuration/themes.md): Change Otter Shell colors and spacing in otter-settings or theme.conf. Per-app overrides inherit from the shared theme when left blank.
- [otter-bar](https://docs.otter-shell.org/desktop/otter-bar.md): Status bar for workspaces, tray, volume, MPRIS, battery, and other widgets.
- [otter-greeter](https://docs.otter-shell.org/desktop/otter-greeter.md): Wayland display manager with PAM login, fingerprint auth, and AccountsService user list.
- [otter-idle](https://docs.otter-shell.org/desktop/otter-idle.md): Idle timeouts, DPMS control, and systemd-logind sleep hooks.
- [otter-jade](https://docs.otter-shell.org/desktop/otter-jade.md): Desktop pet otter with growth stages, care mechanics, and saved state.
- [otter-launcher](https://docs.otter-shell.org/desktop/otter-launcher.md): App launcher with fuzzy search, IME, and calculator, emoji, and clipboard modes.
- [otter-lock](https://docs.otter-shell.org/desktop/otter-lock.md): Session lock screen with PAM login, fingerprint auth, and optional clock.
- [otter-logout](https://docs.otter-shell.org/desktop/otter-logout.md): Power menu overlay for lock, logout, suspend, reboot, and shutdown.
- [otter-notifications](https://docs.otter-shell.org/desktop/otter-notifications.md): Wayland notification daemon for anything that uses freedesktop Notifications over D-Bus.
- [otter-osd](https://docs.otter-shell.org/desktop/otter-osd.md): Short-lived overlays for volume, brightness, and lock-key state.
- [otter-polkit](https://docs.otter-shell.org/desktop/otter-polkit.md): Session polkit agent with a password dialog and optional fingerprint auth.
- [otter-settings](https://docs.otter-shell.org/desktop/otter-settings.md): Graphical editor for Otter Shell app configs, themes, and bar layout.
- [otter-wallpaper](https://docs.otter-shell.org/desktop/otter-wallpaper.md): Wallpaper daemon with per-monitor paths, rotation, and lock screen sync.
- [Session setup](https://docs.otter-shell.org/desktop/session-setup.md): What to autostart at login, how to bind hotkeys, and where otter-greeter fits in.
- [Build Otter Shell from source](https://docs.otter-shell.org/developers/building.md): Compile Otter Shell components locally with Zig 0.16.0 and run tests.
- [Create a new Otter Shell app](https://docs.otter-shell.org/developers/creating-an-app.md): Start a Wayland app on the Otter stack: dependencies, UI patterns, and config.
- [Libraries overview](https://docs.otter-shell.org/developers/libraries.md): Eleven shared Zig libraries that Otter Shell apps link at build time. Stack diagram, compile flags, and repo layout.
- [otter-conf](https://docs.otter-shell.org/developers/libraries/otter-conf.md): Comptime-generic config parser with mmap I/O, serialization, and inotify hot-reload.
- [otter-config-types](https://docs.otter-shell.org/developers/libraries/otter-config-types.md): Typed config structs shared across Otter Shell apps and otter-settings.
- [otter-desktop](https://docs.otter-shell.org/developers/libraries/otter-desktop.md): Desktop integration: XDG icons, D-Bus services, PipeWire, PAM, and sysinfo.
- [otter-geo](https://docs.otter-shell.org/developers/libraries/otter-geo.md): Pure geometry types for layout: Point, Rect, Padding, Transform, Align.
- [otter-render](https://docs.otter-shell.org/developers/libraries/otter-render.md): CPU rendering pipeline: fonts, images, CommandList, quad_renderer, and SDF rounded rects.
- [otter-theme](https://docs.otter-shell.org/developers/libraries/otter-theme.md): Shared theme tokens, spacing, popup styles, and 12 bundled presets.
- [otter-tools-core](https://docs.otter-shell.org/developers/libraries/otter-tools-core.md): Pure-Zig helpers for small CLI tools: calc, emoji, clipboard, calendar, weather, and more.
- [otter-ui](https://docs.otter-shell.org/developers/libraries/otter-ui.md): Widget framework and Surface Description frame API for Otter Shell UI apps.
- [otter-utils](https://docs.otter-shell.org/developers/libraries/otter-utils.md): Pure Zig utilities: BoundedArray, logging, FilePath, inotify, and config path helpers.
- [otter-vte](https://docs.otter-shell.org/developers/libraries/otter-vte.md): Terminal cell rendering: DynamicCommandList, powerline glyphs, and CellRenderer.
- [otter-wayland](https://docs.otter-shell.org/developers/libraries/otter-wayland.md): Wayland client: layer shell, workspaces, keyboard, IME, clipboard, and damage tracking.
- [Developer overview](https://docs.otter-shell.org/developers/overview.md): How the Otter Shell monorepo is laid out and how components connect.
- [Installation](https://docs.otter-shell.org/installation.md): Install Otter Shell with pikman. `otter-shell` is the base desktop; add `otter-shell-extras` for speech tools.
- [About Otter Shell](https://docs.otter-shell.org/introduction.md): Native Wayland apps for a lightweight PikaOS desktop: shell daemons, utilities, and shared libraries.
- [Quick start](https://docs.otter-shell.org/quickstart.md): Launch the terminal, autostart shell daemons, and try screenshot, clipboard, and notes after install.