Expand description
Use case (application service).
High-level operations called from CLI/TUI. Combine the domain layer and persistence layer.
Structs§
- AddItem
Outcome - Result of adding a PBI, including warning-only dependency-cycle information.
- Board
- Board data with columns ordered according to
config.toml. - Board
Column - One board column with its status and PBIs in ascending rank order.
- Board
Query - Filtering, scope, and sorting options for
board. The default includes all PBIs and columns. - Board
Snapshot - A complete read-only snapshot of all board data exposed by
export --json. - Burndown
- Sprint burndown summary.
- Burndown
Day - Observation points for one day of burndown.
- Cycle
Time Filter - Optional filters for Cycle/Lead Time aggregation.
- Cycle
Time Report - Results of Cycle Time / Lead Time analysis.
- Dependency
Outcome - Result of
add_dependency, including the updated PBI and any cycle warning. - Display
Settings - Display settings for the
showcommand. - Doctor
Fix - One safe mechanical change applied by doctor –fix.
- Doctor
Issue - One actionable board-integrity finding.
- Doctor
Report - Result of a board integrity scan.
- Duration
Summary - Summary statistics for a
Durationsample. - Forest
- Parent/child forest over a set of items, classified by membership in that set.
- Item
Detail - Result of
item_detail, with bidirectional links in ascending rank order. - Item
Edit - Fields to update with
edit_item. ANonefield remains unchanged. - Link
Outcome - Result of
link_commitsorunlink_commits, including the updated PBI and changed SHAs. - List
Filter - Filters for
list_items. Empty fields do not filter their corresponding property. - Move
Outcome - Result of moving a PBI, including the computed Acceptance Criteria progress.
- NewItem
- Optional fields for
add_item. Unspecified fields use their domain defaults. - Next
Filter - Filters for
next_items. - Rebalance
Outcome - Result of
rebalance. Indicates the status of resolution of rank bloat. - Search
Filter - A validated search filter over a PBI and its assigned sprint metadata.
- Sprint
Load Warning - A non-blocking warning produced when a Sprint’s assigned points exceed a threshold.
- Sync
Outcome - Result of
sync_commits, listing new(PBI ID, SHA)links. - TuiSettings
- Settings required to launch the interactive Kanban view.
- Undo
Outcome - The result of a successful undo.
- Velocity
Report - Velocity summary for the selected recent sprints.
- Velocity
Sprint - Velocity and estimate coverage for one sprint.
- WipViolation
- A column whose item count exceeds its WIP limit.
Enums§
- Burndown
Metric - The metric a burndown chart tracks.
- Doctor
Issue Kind - Category of an integrity issue.
- Edit
Outcome - Result of
apply_item_edit. - Import
Outcome - Result of
import_board. - Init
Outcome - Result of
init_board. - Label
Match - Matching mode for a multi-label filter.
- Migrate
Outcome - Result of
migrate_storage. - Remove
Outcome - Result of
remove_item. - Reorder
Target - Specify the destination of
reorder_item(how to changerank). - Search
Mode - Search interpretation used by list, board, and Kanban filters.
- SortKey
- Sort key used within a board column.
- Sprint
Close Action - How unfinished PBIs are handled when their sprint closes.
- Sprint
Load Warning Kind - The source of a non-blocking Sprint load warning.
Functions§
- add_
dependency - Add dependency
depto the PBIidand returnDependencyOutcome. - add_
item - Add a PBI to the board in
project_dirand return the savedBacklogItem. - add_
item_ with_ outcome - Add a PBI and report warning-only dependency cycles.
- apply_
item_ edit - Validate Markdown edited with
$EDITOR, apply permitted fields to PBIid, and save it. - archived_
item_ detail - Load archived PBI
idwith bidirectional links. - assign_
sprint - Assign PBI
item_idto sprintsprint_idand return the savedBacklogItem. - assign_
sprint_ by_ status - Assign matching PBIs to a sprint in backlog rank order.
- assign_
sprint_ raw - Assign a PBI from a raw CLI sprint ID, validating its grammar and existence before saving.
- board
- Load the board in
project_dir, grouping PBIs in the column order fromconfig.toml. - build_
forest - Classify
itemsinto aForestby parent membership within the same set. - burndown
- Calculate the burndown for sprint
sprint_idinproject_dir. - check_
wip - Load the board in
project_dirand return the columns that exceed the WIP limit. - clear_
common_ dod - Delete a board’s common DoD.
trueif it exists,false(idempotent) if it does not exist. - close_
sprint - Close the sprint (
active→closed) and return the savedSprint. - common_
dod - Load the board’s common DoD, returning
Nonewhen the file is absent or empty. - create_
sprint - Create a sprint on the board in
project_dirand return the savedSprint. - cycle_
time - Aggregate Cycle/Lead Time for completed PBIs matching
filterinproject_dir. - delete_
sprint - Delete a sprint and clear its assignment from every PBI that references it.
- display_
settings - Read display settings from the board. Return
crate::error::Error::NotInitializedwhen it is uninitialized. - doctor
- Inspect a board and optionally apply safe, mechanical repairs.
- edit_
item - Update the specified fields of PBI
id, refreshupdated, and return the savedBacklogItem. - edit_
sprint - Update the title, goal, and/or planned period of an existing sprint.
- export_
snapshot - Load one read-only snapshot containing the board PBIs, Sprints, configuration, and common DoD.
- hierarchical
- Reorder
itemsinto canonical hierarchical priority order. - hierarchical_
order - Pre-order traversal of the fully-expanded forest: every root in input order, each parent immediately followed by its subtree (children in input order). Cycle-only items are appended at the end so no item is lost.
- import_
board - Restore the board in
project_dirfromsnapshot. - init_
board - Initialize
.pinto/(config.tomlandtasks/) inproject_dir. - item_
detail - Load PBI
idwith backward links (children and dependents). - item_
edit_ template - Format PBI
idas the Markdown template used for$EDITORediting. - link_
commits - Add commit SHAs in
shasto PBIidand returnLinkOutcome. - list_
items - Return PBIs from
project_dirin canonical hierarchical priority order. - list_
sprints - Return sprints from
project_dirin ascending creation-time order. - lock_
board - Acquire the board write lock for a caller that needs a consistent board snapshot.
- migrate_
storage - Migrate from the current backend to
targetand switch the save location ofconfig.toml. - move_
item - Move PBI
idto workflow statustoand return the savedBacklogItem. - move_
item_ with_ outcome - Move PBI
idand return the metadata needed by user interfaces for transition warnings. - next_
items - Return the highest-ranked PBIs that are ready to start without modifying the board.
- rebalance
- Reassign oversized or duplicated ranks within each
(status, parent)sibling scope. - remove_
dependency - Remove dependency
depfrom PBIidand return the savedBacklogItem. - remove_
item - Delete PBI with
id. The default is archive backup, and ifpermanentis true, physical deletion is performed. - reorder_
item - Sort the PBI by
idwithin its sibling group and return the savedBacklogItem. Change onlyrank; keepstatusandparent. - restore_
item - Restore archived PBI
idto the active backlog and return the unchanged item. - set_
common_ dod - Replace the board’s common DoD and return the written file path.
- set_
sprint_ capacity - Update sprint capacity settings and return the calculated capacity.
- show_
archived_ item - Load archived PBI
idfrom the board inproject_dir. - show_
item - Load PBI
idfrom the board inproject_dir. - sprint_
capacity - Return the configured capacity for a sprint.
- sprint_
load_ warnings - Calculate the current load warnings for a Sprint without changing board data.
- start_
sprint - Start a sprint (
planned→active). Returns the savedSprint. - sync_
commits - Synchronize commit links from
git logby associating commits whose messages contain a PBI ID. - template_
body - Read
.pinto/templates/<kind>/<name>.mdas plain text. - tui_
settings - Read TUI settings from the board. Return
crate::error::Error::NotInitializedwhen it is uninitialized. - unassign_
sprint - Remove PBI
item_idfrom sprintsprint_idand return the savedBacklogItem. - undo_
last_ mutation - Revert the most recent completed board mutation.
- unlink_
commits - Remove commits matching the SHA prefixes in
shasfrom PBIidand returnLinkOutcome. - velocity
- Aggregate velocity for the most recent
recentsprints inproject_dir. - wip_
violations - Compare each column limit in
configwith the corresponding item count and return the columns that exceed their limits.