Overview
The local workspace, source-backed work, and the current setup path.
Brainlyy helps you work with approved files, tools and computers. The local Work screen can create a source report, detect changed sources and prepare a checked replacement. Existing connections provide access to local models and saved code graphs. Local use does not require an account.
Source content stays on the owning computer by default. Approved remote requests can carry content through the hosted relay. Optional external providers have their own credentials and data boundaries.
This is development software. Signed installers and the full autonomous platform are not yet qualified for release. Start with release status, maintained work, remote reports, managed graphs, architecture and the delivery agreement.
1. Development installation
The repository is private, and public installers are not yet available. These commands need an authorized checkout and Python 3.10 or newer. See Install for the developer path.
python -m pip install .
Local source reports do not require a model runner, vector database or remote account. See Concepts for optional capabilities.
2. Set it up
brainlyy init --no-register
This asks at most three questions and provides defaults. It generates local
credentials, renders templates and runs the property suite. The --no-register
flag leaves MCP client registration for a separate decision.
If that suite fails, init says so and does not report success. A setup
command that claims "done" without checking is how people end up with a system
that is confidently broken.
Already have notes?
Point Brainlyy at the folder they are in. It reads them where they are: it adds nothing to your folder, moves nothing, and creates nothing beside them. Sub-folders are included.
Where do your notes live? /Users/you/Documents/notes
Everything Brainlyy writes for itself (its config, its tokens, its evidence log, and anything you delete from the dashboard) lives in its own directory, not in yours. Your folder may be a git repository, an Obsidian vault or a synced directory, and none of those are Brainlyy's to reorganise.
A new claim you write from the dashboard is a markdown file in your folder, because that is what a claim is. Nothing else goes there.
Getting back in
Setup offers a passphrase. Set one and this is all you need, from any browser on the machine:
http://127.0.0.1:8780
Skip it and the only way in is the link brainlyy ui prints, which carries
your read token in the query string. Bookmark that and the token is in your
browser history; lose it and you are back in a terminal. The passphrase is
what makes a plain bookmark work.
Set or change one later with brainlyy passphrase. Ten characters minimum; a
sentence is easier to remember and harder to guess than symbols.
3. Look at it
brainlyy ui
Opens the dashboard: what tier you are at, what is missing, your notes with their provenance, and, if you have indexed one, your code graph. Binds loopback by default. See Security to reach it from a phone.
brainlyy doctor # the same status, in the terminal
brainlyy search <q> # query your notes without a browser
4. MCP server
init already registered it. Your assistant gains search_notes,
ask_fast, ask_licensed and code_search. On the machine itself it also
gains post_message, run_agent, agent_status and rate_answer.
Read tools bind your private network address. Write tools bind loopback and the process exits if configured otherwise. They hold different tokens, so the credential that travels your network cannot act. See Security.