Config and runtime paths

config_paths is where Otter Shell XDG locations live. Don’t hardcode ~/.config/otter-shell/ in app code.

Config and data

const paths = @import("otter_utils").config_paths;

var buf: [std.fs.max_path_bytes]u8 = undefined;

// ~/.config/otter-shell/myapp.conf
const conf = paths.otterConfigPath(&buf, "myapp.conf") orelse return error.NoHome;

// ~/.config/otter-shell/ (trailing slash)
const dir = paths.otterConfigDir(&buf) orelse return error.NoHome;

// ~/.local/share/otter-shell/...
const data = paths.otterDataPath(&buf, "clip-history.json") orelse return error.NoHome;

Helpers exist for cache dirs, paths from an explicit home directory (tests), and ensuring cache directories exist.

Runtime directory

State under $XDG_RUNTIME_DIR/otter-shell/:

const runtime = paths.otterRuntimePath(&buf, "wallpaper-state") orelse return error.NoRuntime;
try paths.ensureOtterRuntimeDir(allocator);

runtime_state reads and writes small state files here. Wallpaper state keeps lock screens and generated themes in sync. Do Not Disturb uses dnd-state through isDndEnabled, setDndEnabled, and toggleDnd. Writes are locked and atomic so the bar and CLI can toggle it safely at the same time. runtime_socket builds bounded socket paths and can restrict socket FD permissions.

Legacy migration

legacy_paths migrates old /tmp/otter-* clip and weather cache files into XDG data dirs on first access. Call the resolve* helpers rather than opening legacy paths directly.

Assist helpers

assist parses JSON chat requests and formats ChatML prompts. Used by otter-assist (packaged in otter-shell-extras).

Getting Started

Libraries

Config and runtime paths

Config and data

Runtime directory

Legacy migration

Assist helpers

​Config and data

​Runtime directory

​Legacy migration

​Assist helpers

Config and data

Runtime directory

Legacy migration

Assist helpers