Start keeping project knowledge

Set up Lore, connect a project, and find your first entries.

Lore is coming soon. These guides describe the upcoming release.

Lore

Check availability and requirements

Lore is coming soon. The npm package is not published yet. The commands here show how installation will work after publication.

You will need Node.js 22.17 or later in the 22.x series, or Node.js 24.2 or later. Keep Lore's active data on a local disk.

After publication, a global installation makes the command available across your projects. You can also install it as a development dependency in one project.

After publication: choose one installation
npm install -g zedbee-lore

# Alternative: install in one project
npm install --save-dev zedbee-lore
Lore

Set up your project

Open a terminal in your project and run the setup command. Read the proposed changes before applying them. New projects use review capture: submitted discoveries wait for review before becoming active knowledge.

For a project-local installation, use npm exec --no -- zedbee-lore in place of zedbee-lore. That runs your installed copy without downloading another version.

Set up and check Lore
zedbee-lore init
zedbee-lore doctor
Lore

See what is already known

List the knowledge for an area of the code, or search for a particular topic. A new store can return no entries; that is a successful search with nothing saved yet.

Use zedbee-lore projects list to see your project ID. You will need it when adding your first project entry.

Look around
zedbee-lore list
zedbee-lore list --path src/jobs/
zedbee-lore projects list
Lore

Add a useful discovery

Start with one thing a future developer or agent would benefit from knowing. Explain why it matters and include evidence.

Record your first discovery

Connect a coding agent