Installation

Before you start

• Node.js 24 or newer. Check with node --version.
• macOS or Linux. Windows is explicitly out of scope at v0.1.
• Nothing else. No account, no API key, no network access at run time.

Frombrand/quickstart.md · Before you start

Install

Install the lore command from npm:

npm install -g create-lorekeeper

The package is create-lorekeeper because the bare name lorekeeper on npm belongs to an unrelated project; the command it installs is lore. To try it once without installing, npx create-lorekeeper init ~/brain makes the same brain lore init ~/brain does.

Then check it:

lore --version
lore --help

lore --help is the full command surface. There are three commands.

Every later command on this page is written as lore …. Without a global install, npx create-lorekeeper … runs the same program with the same arguments.

Frombrand/quickstart.md · Install