`jellycell.cli.journal`¶

Append-only analysis journal for jellycell run.

Writes one markdown section per invocation to manuscripts/journal.md (or the path configured in [journal] path). Enabled by default — the audit trail is usually more valuable than an empty file, and the entry is small + human-readable so it stays useful even in clean projects.

The journal is append-only from jellycell’s side. Users are free to hand-edit existing entries (commentary, corrections, retrospective notes); the next jellycell run only adds new entries at the bottom without touching prior text.

Module Contents¶

Functions¶

Append a journal entry for report. Returns the journal path, or None if disabled.

API¶

jellycell.cli.journal.append_entry(project: jellycell.paths.Project, report: jellycell.run.RunReport, *, message: str | None = None, now: datetime.datetime | None = None) → pathlib.Path | None¶: Append a journal entry for report. Returns the journal path, or None if disabled.