8gent Code.Docs
Getting started

First run

What 8gent asks the first time you open it, what it checks by itself, and what it saves.

Needs a current release

This is the first run in current releases. Run 8gent update if yours looks different. See Install.

The splash

The living 8: a braille figure eight in orange above "8gent Code" and "Free, local, open. Yours."

Dots start on a ring, fly in and land as a braille 8, pulse once, then a slow colour wave runs down the stroke. About 1.5 seconds. It shows on the first run and once after each update, never on an ordinary launch. Any key skips it; a letter you type lands in the input box.

On a Mac a short launch tune plays at low volume while the splash shows, and fades out when ffplay is installed. /quiet stops it at once.

There is no splash when motion is reduced, when the terminal is too small or cannot draw braille, or with 8GENT_NO_INTRO=1.

Setup, in the chat

Setup happens in the chat. 8gent asks, you answer in the input box. Enter on its own always takes the default, so pressing Enter through the whole thing is fine.

StepQuestionEnter gives you
1"Good day. I'm 8gent." plus what it found on this machineBegin
2What should I call you?Your git name, if one was found
3What best describes you? Engineer, Designer, Founder, Hobbyist, OtherEngineer
4What are you working on? One short lineSkip
5How should I communicate with you? Five stylesDry-witted, sarcastic, seriously motivational
-Local engine checks: Ollama (or llama-server), LM Studio, Apple Foundation. One line each, nothing to answer-
6-8Name your Orchestrator, Engineer and QA agentsOrchestrator, Engineer, QA
9What should your 8gent be called?Eight
10Voice: your computer's own natural voice, or also a small local voice model (about 200 MB, opt-in)Natural system voice
11Pick a voice: 14 choicesNatural system voice
12A recap of your answers. Ready to begin?Yes, let's go

Then the workspace opens in Ask mode, on the first local model it found. The agent names become the tab titles. Your name, role and style are given to every agent at the start of each session.

What it checks by itself

While the welcome is on screen, each check capped at a few seconds, 8gent reads:

  • your git name and your GitHub sign-in (gh), if present
  • the models in your local Ollama, or llama-server when EIGHT_LOCAL_SERVER=llama-server
  • whether LM Studio and the Apple Foundation bridge answer
  • whether Python and the optional local voice are installed

It only talks to engines on this machine, or the addresses you set (OLLAMA_HOST, LM_STUDIO_HOST, APFEL_BASE_URL, LLAMA_SERVER_URL). An engine check is "does it answer". It does not load a model.

Skipping setup

Do thisWhat happens
/skipSkips this question
/skip all or EscEnds setup now. It will not ask again
8gent --yes or 8gent -yStarts with no setup at all

What it saves

Everything stays in ~/.8gent/ on your machine.

PathWhat is in it
~/.8gent/user.jsonYour profile and answers, what was detected, and onboardingComplete, the flag that stops setup showing again
~/.8gent/settings.jsonApp settings: voice, performance, per-tab models, agent names
~/.8gent/intro-seenThe version that last showed the splash
~/.8gent/sounds/launch.mp3The launch tune. Replace it to change the sound
~/.8gent/memory/, sessions/, tabs/Memory, chat history and tab state

Change it later

CommandWhat it does
/onboardingRuns setup again from the start
/preferencesShows your saved profile
/settingsOpens the Settings tab: voice, performance, providers, models
/voice on, /voice offSpeaking replies aloud on or off
/provider, /modelPick a different engine or model

To start completely fresh, quit 8gent and delete ~/.8gent/user.json. Delete ~/.8gent/intro-seen as well to see the splash again.

Next: Your first task.