Installation & Setup

Requirements

Install steps

1. 1

   Download the installer

   Grab Flunkey_x.y.z_x64-setup.exe (NSIS) from /download or the GitHub Releases page. Keep the file — re-running it updates the app.

2. 2

   Run it

   Double-click the installer. If Windows SmartScreen appears, do not close it — follow the bypass below.

3. 3

   Complete onboarding

   Flunkey opens to the onboarding banner. Pin it to the taskbar if you like, then continue to API keys.

4. 4

   Add a key

   Settings → paste one provider key. See API Keys & Providers for which to pick first.

First-run onboarding

Launching Flunkey the first time walks you through 8 steps. On completion your name, keys, and provider choice are saved and onboardingDone is set.

1. 1

   Step 0 · Name

   Enter a name or nickname — used for the Dashboard greeting.

2. 2

   Steps 1–3 · Hotkey tour

   F8 / F9 / F10 explainers with banners. Skim them; the pattern is always hold → speak → release.

3. 3

   Step 4 · Microphone

   Full-bleed permission screen. You must Allow — without mic access nothing records.

4. 4

   Step 5 · API keys

   Four provider fields (Groq, OpenAI, Gemini, OpenRouter) with Test badges. At least one must test OK to continue.

5. 5

   Step 6 · Autostart

   Launch at login, default ON. Autostart launches minimized to the tray.

6. 6

   Step 7 · Terms

   Legal banner — accept Privacy/Terms/About (Legal v1.0.0), then Launch.

To re-run setup later: Settings → Re-run setup (resets onboardingDone=false).

SmartScreen bypass

Releases are not code-signed yet, so Windows flags the unknown publisher. This is expected and temporary. In the blue “Windows protected your PC” dialog, click More info, then Run anyway.

Verify the install

• The Flunkey tray icon appears in the Windows taskbar tray
• Opening Settings shows the provider key fields and hotkey remapping
• Holding F8 in Notepad lights up the bottom pill and plays the start sound

Next: API Keys & Providers