Skip to main content

Module api

Module api 

Source
Expand description

What a front end may read and do: Query returns a View of plain data, and Action returns an Outcome. The CLI, the TUI and the web each render these, so a front end that matches every variant cannot fall behind another. Design: docs/dev/frontends.md.

An action that runs agents or waits on the network is queued as a job running the same CLI command, so no front end blocks on it.

Structs§

Outcome
What an action did. said goes to standard output, warnings to standard error.
Portfolio
What the last scan recorded, for tiered projects.
Selection
Projects named outright and those carrying any of tags; empty is all.
WorkerChoice
The worker a queued action names, as -a, -m and -p do.

Enums§

Action
Query
View

Functions§

act
busy
Whether a job or an agent run is under way, so a front end refreshes often rather than now and then.
changelog
A run’s drafted changelog entries: None when its project keeps no CHANGELOG.md and the agent drafted none, empty when it should have.
command_line
The CLI command a queued action runs; None for one that runs in place.
config
has_run
Whether a run that is not final holds this task, by key or by its text.
next_lists
portfolio
query
select
The projects named outright together with every project carrying one of tags. Empty means all of them, so a --tag that matches nothing is an error rather than a silent selection of the whole portfolio.
settle_interrupted
Marks runs whose session died failed, when no session holds the lock.
whoami