Record your work

glaurung journal

Keep dated notes in a project.

writes files or project state 2 worked examples

use it for

Journal entries belong to the project rather than one address. Use comments for address-specific notes.

Run glaurung journal --help on your installed version before putting the command in a script. Glaurung is still pre-1.0.

input
A project plus add, list, or delete. Journal text is not tied to one address.
output
Dated project notes with stable numeric IDs.
mode
writes state. add and delete update the project.

command shape

syntax

short form
$ glaurung journal PROJECT {add|list|delete} ...

The installed parser is authoritative: glaurung journal --help

before the examples

project setup

The examples use the checked-in hello-c-clang-debug fixture and a project named hello.glaurung.

$ glaurung kickoff samples/binaries/platforms/linux/amd64/export/native/clang/debug/hello-c-clang-debug --db hello.glaurung

run it

examples

Record what you checked

Write enough detail that the next session knows which evidence you inspected.

run

from the engine checkout
$ glaurung journal hello.glaurung add checked main against disassembly

output

captured result captured 2026-08-31
journal #1  checked main against disassembly

captured 2026-08-31.

Read the result: The returned ID is the handle for deletion. The journal records work performed; it does not attach this claim to main's address.

Read the latest notes

The journal stays with the project when you export or reopen it.

run

from the engine checkout
$ glaurung journal hello.glaurung list --limit 10

output

captured result captured 2026-08-31
#1  2026-08-31 20:09:05
  checked main against disassembly

captured 2026-08-31.

Read the result: Newest entries appear first. Use a journal for session history and comments for address-level findings.

used above

important options

add TEXT
Append a project note.
list
Print newest entries first.
--limit N
Cap the number of listed entries.
delete ID
Remove one entry by ID.

These are the flags used by the examples. Run glaurung journal --help for the complete parser help.

before you rely on it

checks

keep working

related commands

← all 40 commands