Crate treeboot_core 

Core library for treeboot.

This crate contains the reusable worktree bootstrap logic. The treeboot binary crate provides the command-line interface on top of this API.

Structs

ActionPlan

A validated set of file operations and commands ready for execution.

ActionPlanOptions

Options that affect declarative run planning.

CommandOperation

A normalized command operation.

Config

Parsed and normalized treeboot config.

ConfigOptions

Options for inspecting a treeboot config.

ConfigRuntimeOptions

Runtime options declared by a config file.

ExecuteOptions

Options that control action plan execution.

ExecutionReport

Result summary for action plan execution.

Executor

Executes validated action plans.

FileOperation

A normalized file operation.

FileOperationCompletionOptions

Options for root-relative source completion.

FileOperationOptions

Options for running one manual file operation command.

FileOperationReport

Result summary for a manual file operation invocation.

InitOptions

Options for treeboot init.

InitReport

Result summary for treeboot init.

InitScriptDiscovery

Discovered treeboot init scripts for a worktree.

LoadedConfig

Loaded treeboot config selected for a worktree.

ManualFileOperationOptions

Options for building manual file operation specs.

PlannedCommand

A validated command operation ready for execution.

PlannedFileOperation

A validated file operation ready for execution.

RunOptions

Options for running worktree bootstrap.

RunReport

Result summary for a treeboot run invocation.

RuntimeOptionOverrides

Environment overrides for config runtime options.

SourceSpan

Byte and line location for a declaration in a config file.

StatusOptions

Options for inspecting treeboot discovery status.

StatusReport

Result summary for a treeboot status invocation.

Worktree

Resolved Git worktree metadata used by treeboot operations.

WorktreeOptions

Options for discovering a Git worktree.

Enums

CommandKind

Command invocation kind.

Error

Error type for treeboot-core operations.

FileOperationAction

Completed action for a manual file operation invocation.

FileOperationKind

File operation kind.

InitKind

Init file type to create.

InitScriptStatus

Init script discovery status for a worktree.

OutputEvent

A structured message produced during a treeboot operation.

PlanOrigin

Source of a validated action plan.

PlannedFileStatus

Execution status for a planned file operation.

RunAction

Completed action for a treeboot run invocation.

SymlinkMode

Copy or sync symlink handling.

SyncCompare

Sync comparison mode.

Traits

Reporter

Receives structured output events from core operations.

Functions

file_operation_source_candidates

Returns source completion candidates relative to the resolved root checkout.

init

Creates a starter treeboot config or init script.

inspect_config

Parses, normalizes, and returns the selected config file.

inspect_status

Inspects worktree, root, init script, and config discovery status.

run

Runs worktree bootstrap according to the provided options.

run_file_operation

Runs a manual copy, symlink, or sync file operation.

Type Aliases

CommandSpec

Raw command intent used to build an action plan.

ConfigReport

Result summary for a treeboot config invocation.

Environment

Environment variable map built for scripts and configured commands.

FileOperationSpec

Raw file operation intent used to build an action plan.

Manifest

Parsed treeboot manifest.

ManifestOptions

Options for inspecting a treeboot manifest.

ManifestReport

Result summary for manifest inspection.

Result

Convenient result type used by treeboot-core.

RuntimePolicy

Resolved runtime policy from defaults, config, environment, and CLI flags.