Skip to main content

Module report

Module report 

Source
Expand description

Read-only verbs. Every function returns its text instead of printing, so a CLI, an MCP server, and a library caller share one implementation.

Re-exports§

pub use crate::related::related;

Structs§

CheckReport
Outcome of check: the findings, and how many were errors.

Functions§

agenda
Dated open work in the next days days, plus anything already overdue. One line per (issue, date kind): deadlines first within a day, soonest day first, overdue on top with a negative day count.
ancestors
Transitive blocker ancestors, limited to a bounded number of hops.
backlinks
Every issue referring to target_id through a blocker edge, a parent link, a discovered-from link, or a body mention. The relation is named on the row.
check
Validate the corpus: every parent and blocker id resolves, dates parse, open issues carry a creation date, and ids are unique across projects.
children
Issues whose :PARENT: points at parent_id.
claims
Every live claim, oldest first: the who-holds-what view. A claim is live while its issue is STARTED or BLOCKED (release happens on TODO, DONE, or CANCELLED), so this is the working set, not history.
count
The matching issue count and nothing else, for shell pipelines.
cycles
Cycles in the blocker graph, one per line, or a line saying there are none.
export
One JSON object per line: every property, the logbook, the body, and the file line range. Round-trippable, and the seam other tools consume.
export_by_project
The same lines as export, grouped by project, from one read.
graph
The whole blocker and parent graph as Graphviz DOT. Node fill encodes state.
impact
Transitive issues waiting on this issue, limited to a bounded number of hops.
list
One row per issue: id, state, priority cookie, title.
ready
Actionable issues: TODO or STARTED with no open blocker.
roadmap
A markdown roadmap grouped by project and state. Closed items collapse into one section so the document stays about live work.
search
Case-insensitive substring scan over id, title, properties, and body. Linear in the corpus, which is the right cost until the issue count climbs.
show
One issue’s metadata and file range. The body stays in the file: an editor opens the range when the prose is wanted.
stale
Open issues whose :CREATED: is at least days old. An issue without a parseable date is never stale, because its age is unknown.
tree
Children and blockers below root_id, as indented text or Graphviz DOT.