Skip to content
Brainlyy

Install

Set up from source, choose your workspace, and understand what is available today.

Public installers are not yet available. The product repository is private. These instructions are for developers who already have repository access. They are not the planned terminal-free customer setup.

Use Python 3.10 or newer, Git and pip. Installation can download package dependencies. A local workspace does not require an account. Remote access and external providers can transmit approved content outside the computer.

Install from an authorized checkout

git clone https://github.com/bidurkhatri/Brainlyy
cd Brainlyy
python -m pip install .

GitHub must authenticate an account with access to the repository. If you do not have access, there is no public source download to use instead. See release status for distribution requirements.

Set up an instance

brainlyy init --no-register

Three questions, all defaulted:

  1. Organisation or project name. Defaults to the current directory name
  2. Where notes live. Defaults to ~/.brainlyy/vault
  3. Bind address for the read server. Defaults to a detected mesh address, else 127.0.0.1

Then it generates tokens, renders templates and runs its property suite. The --no-register flag leaves client registration for a separate decision. Non-interactive shells take every default, so brainlyy init --no-register < /dev/null works in CI.

Where things go

~/.brainlyy/                 # or $BRAINLYY_HOME
  config.yaml               # yours to edit; no secrets in it
  read-token.txt            # generated, never rotated silently
  write-token.txt
  vault/                    # your markdown notes
  brain/knowledge/          # rendered knowledge base
  brain/souls/              # one file per agent

The instance lives outside the package install. Back up the instance before an upgrade. Migration and restore qualification remain release requirements.

Platform notes

Windows. Development checks use PowerShell. If you register the MCP server manually, note that where/Get-Command resolve .cmd shims that a bare process launch does not. brainlyy handles this internally by resolving the executable before invoking it.

macOS / Linux. Install into a virtual environment and use its executable path if brainlyy is not on PATH. Signed native releases and clean-device installation checks remain pending.

All platforms. brainlyy doctor never requires anything to be running. If it reports tier 0 on a machine where you know Ollama is up, the probe is telling you it could not reach it on the configured port. Check ports.ollama in your config.

Adding capabilities later

Nothing needs reinstalling. Start the dependency, and the next brainlyy doctor picks it up:

To reach Start
Tier 1 a local model runner on ports.ollama
Tier 2 a knowledge-base backend on ports.knowledge_api
Tier 3 set hosts.vps_ssh_alias to a working SSH alias
Tier 4 set hosts.public_fqdn and enable edge

Uninstall

python -m pip uninstall brainlyy

Uninstalling the package preserves the instance directory. Review and back up that directory before separately deleting any source files or saved reports.

PreviousOverviewNextRelease status