Reference

Files and environment

Where Ferret keeps its own files, and the environment variables it reads or sets.

#userData folder

App data lives in Electron's userData folder. Its name is pinned to ade-movie (not the product name), so data survives renames. Override it with --user-data-dir=<path>.

OSPath
macOS~/Library/Application Support/ade-movie/
Windows%APPDATA%\ade-movie\
Linux~/.config/ade-movie/ (or $XDG_CONFIG_HOME/ade-movie/)
settings.json       # settings before 0.1.1, kept as a backup (now ~/.ferret/settings.json)
stt-keys.bin        # API keys, encrypted with safeStorage
browser-import/     # imported passwords (passwords.bin, encrypted with safeStorage) and history (history.json)
feedback-share/     # share links you made (shares.bin; owner tokens encrypted with safeStorage)
login-shell-path.json  # your login shell's PATH from the last launch, so agent tabs start without waiting
models/             # downloaded whisper models (ggml-*.bin)
accounts/claude/<id>/   # CLAUDE_CONFIG_DIR for added accounts
accounts/codex/<id>/    # CODEX_HOME for added accounts

Your settings are not in this folder: they live in ~/.ferret/ (see Configure with settings.json).

A model you picked yourself can live anywhere. The legacy default location ~/.cache/ade-movie/models/ggml-small.bin is still checked.

#Environment variables

VariableEffect
CLAUDE_CONFIG_DIR, CODEX_HOMESet by Ferret for agent tabs when an added account is selected
GH_TOKEN, GITHUB_TOKENUsed by gh ahead of its own login. Ferret warns when either is set
FERRET_CONFIG_DIR (or the old MOVIE_ADE_CONFIG_DIR)Folder for settings.json, state.json and settings.schema.json instead of ~/.ferret
Names in apiKeyEnvAPI keys you point to from settings.json. Also read from the project's .env and ~/.ferret/.env
ADE_PROJECT_DIROpen (and register) this folder as the project on launch
ADE_INITIAL_URLLoad this URL in the built-in browser on launch
ADE_WHISPER_MODELAbsolute path of a GGML model to use for on-device transcription, overriding the downloaded default
ADE_TERMINAL_PREWARM0 stops Ferret from keeping one shell ready in the background. By default the next plain shell tab uses it, so its prompt appears at once
FERRET_SENTRY_DSN (or the old MOVIE_ADE_SENTRY_DSN)Where crash reports go. Empty means none are sent (see Crash reports)
OPENAI_API_KEYRead from .env in development only (pnpm dev), never in packaged builds
PATHUsed to find your agents' commands (claude, codex, gemini…), gh, git, whisper-cli. On macOS and Linux, Homebrew, linuxbrew, and snap locations are added

#Inside your project

  • .ferret/reviews/<id>/: reviews (see Data and privacy). Older reviews in .ade-movie/reviews/ are still read
  • .git/info/exclude: one line, .ferret/, added on first recording

Edit this page on GitHub (opens in a new tab)