Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

The welcome tour

The first time you sign in after installing from the bromigOS USB stick, a short tour opens full screen. It walks you through the things worth setting first. Every step has Skip, and nothing changes until you press Continue on it.

To take the tour again: Settings › About › Welcome tour, or run bromigos welcome.

The steps

  1. Wi-Fi, only when you’re not connected. Pick a network and type its password.

  2. Your screens. Which screen is the main one: the live background and the panels go there. Arrange and sizes… opens Settings › Displays.

  3. A world. The themes, as pictures of the desktop wearing them. Click one to put it on.

  4. VECTOR, your desk’s AI. Choose where his brain runs:

    • Your lab: your homelab’s model server, found on the next step (or the one you already connected).
    • This computer: only offered when your graphics card has 8 GB of memory or more. The tour shows the model the lab catalog picks for your card and how much it downloads. It installs what’s needed through the system’s own password prompt, in the window: no terminal.
    • A service: any OpenAI-compatible server you name, with its address, model and a file holding its key.
    • Not now: he waits until you give him one.

    When the brain works, VECTOR says hello in the window, and out loud if he has a voice. His voice is the second choice: off, Kokoro (runs on the processor), or the designed voice (needs a graphics card). A voice downloads its model once; the window shows how far it’s got.

  5. Your lab, all in the window:

    • Find looks for your lab on your network. It only reads what this computer already knows (devices that announce themselves, its list of nearby devices, your Tailscale devices); it never scans. It lists each lab machine with what it offers, such as models and services. Nothing is written until you press Connect.
    • I have a lab connection file: pick a homelab.toml, or the lab connection from a Field Kit stick.
    • Make this computer my lab: only with a capable graphics card. It shows bromigos-lab’s reviewed plan for this computer before anything happens.
    • Skip.

    Problems are said in plain words, with what to do.

  6. Pair your phone with the BRODEC app: see Pair your phone.

  7. The keys. Super+Space, Super+Enter, Super+, and a few more. Press one and its card lights up.

  8. Done, with what you chose.

Every step works with the keyboard alone: Tab moves, Enter continues, Esc goes back. Every control has a hover hint, which a screen reader reads too.

bromigOS Server

bromigOS Server’s tour runs in the terminal at your first sign-in, at its console or over SSH (bromigos welcome-console). It has the same steps without the desktop ones: the network, SSH, VECTOR, your lab, pairing your phone, and a short tour of what’s on the server. The pairing QR code is drawn in the terminal at 80×24 and bigger; on a smaller window it shows the short code and asks you to make the window bigger for the QR.

For power users

Every choice in the tour is one bromigos setup command, the same one you can run yourself. The tour keeps no settings of its own.

Tour stepThe command
Your screensbromigos setup monitors --monitors auto --primary OUTPUT
A worldbromigos setup theme --theme NAME
VECTOR: Not nowbromigos setup vector --vector none
VECTOR: This computerbromigos setup vector --vector ollama --model MODEL (after Ollama and the model are installed)
VECTOR: Your lab, A servicebromigos setup vector --vector openai --base-url URL/v1 [--model MODEL] [--api-key-file FILE]
VECTOR’s voicebromigos setup voice --voice off|cpu|gpu
Your lab: Findbromigos setup homelab --find --yes --json --print (what it found, nothing written)
Your lab: Connectbromigos setup homelab --find --yes
Your lab: a filebromigos setup homelab --homelab FILE
Make this computer my labbromigos lab provision plan --repo DIR --preset core (the plan)

To script the whole tour, run those commands in order, or put the answers in a file: bromigos setup --answers FILE takes the same TOML the installer’s first-run answers use (First run). The hello test is bromigos-holo ask "Say hello".

The tour opens once because the installer leaves ~/.local/state/bromigos/welcome-pending; the session’s autostart runs bromigos welcome --if-pending, which does nothing without it. Finishing removes the file and writes what you chose to ~/.local/state/bromigos/welcome.json. bromigos welcome --step STEP opens it on one step; bromigos welcome --render DIR draws every step to pictures and exits.