Skip to main content

Module api

Module api 

Source
Expand description

Operations by entry id, for the command line: what an agent (or a script) does without a screen. They go through the same Brain actions as the desktop app, so tracking rules, tag colors and file names behave exactly as there.

  • json: entries as JSON, for scripts.
  • text: entries as compact text, for agents.
  • [context]: the markdown summary an agent reads at the start of a session.

Modules§

json
Entries as JSON, for --json. A separate shape from Task, so the file format and the JSON can evolve independently, and timestamps read the same as in the files.
text
Entries as compact text for agents: what show, search and the write commands print. Short on purpose, since agents pay for every token they read: dates without seconds or offsets, empty sections left out, sessions as one total, and only the latest history. The full record stays in the entry’s file, whose path show gives.

Enums§

ApiError
Why an operation by id was refused, as the CLI prints it.