ralph_core/
lib.rs

1//! # ralph-core
2//!
3//! Core orchestration functionality for the Ralph Orchestrator framework.
4//!
5//! This crate provides:
6//! - The main orchestration loop for coordinating multiple agents
7//! - Configuration loading and management
8//! - State management for agent sessions
9//! - Message routing between agents
10//! - Terminal capture for session recording
11//! - Benchmark task definitions and workspace isolation
12
13#[cfg(feature = "recording")]
14mod cli_capture;
15mod config;
16pub mod diagnostics;
17mod event_logger;
18mod event_loop;
19mod event_parser;
20mod event_reader;
21pub mod file_lock;
22mod git_ops;
23mod handoff;
24mod hat_registry;
25mod hatless_ralph;
26pub mod hooks;
27mod instructions;
28mod landing;
29pub mod loop_completion;
30pub mod loop_context;
31pub mod loop_history;
32pub mod loop_lock;
33mod loop_name;
34pub mod loop_registry;
35mod memory;
36pub mod memory_parser;
37mod memory_store;
38pub mod merge_queue;
39pub mod planning_session;
40pub mod preflight;
41pub mod preset_source;
42#[cfg(feature = "recording")]
43mod session_player;
44#[cfg(feature = "recording")]
45mod session_recorder;
46pub mod skill;
47pub mod skill_registry;
48mod summary_writer;
49pub mod task;
50pub mod task_definition;
51pub mod task_store;
52pub mod testing;
53mod text;
54mod urgent_steer;
55pub mod utils;
56pub mod wave_detection;
57pub mod wave_prompt;
58pub mod wave_tracker;
59pub mod workspace;
60pub mod worktree;
61
62#[cfg(feature = "recording")]
63pub use cli_capture::{CliCapture, CliCapturePair};
64pub use config::{
65    CliConfig, ConfigError, CoreConfig, EventLoopConfig, EventMetadata, FeaturesConfig, HatBackend,
66    HatConfig, InjectMode, MemoriesConfig, MemoriesFilter, RalphConfig, ScratchpadConfig,
67    SkillOverride, SkillsConfig,
68};
69// Re-export loop_name types (also available via FeaturesConfig.loop_naming)
70pub use diagnostics::DiagnosticsCollector;
71pub use event_logger::{EventHistory, EventLogger, EventRecord};
72pub use event_loop::{
73    EventLoop, LoopState, ProcessedEvents, ProcessedEventsWithWaves, TerminationReason, UserPrompt,
74};
75pub use event_parser::EventParser;
76pub use event_reader::{Event, EventReader, MalformedLine, ParseResult};
77pub use file_lock::{FileLock, LockGuard as FileLockGuard, LockedFile};
78pub use git_ops::{
79    AutoCommitResult, GitOpsError, auto_commit_changes, clean_stashes, get_commit_summary,
80    get_current_branch, get_head_sha, get_recent_files, has_uncommitted_changes,
81    is_working_tree_clean, prune_remote_refs,
82};
83pub use handoff::{HandoffError, HandoffResult, HandoffWriter};
84pub use hat_registry::HatRegistry;
85pub use hatless_ralph::{HatInfo, HatTopology, HatlessRalph};
86pub use hooks::{
87    HookDefaults, HookEngine, HookExecutor, HookExecutorContract, HookExecutorError,
88    HookInvocationPayload, HookMutationConfig, HookOnError, HookPayloadBuilderInput,
89    HookPayloadContext, HookPayloadContextInput, HookPayloadIteration, HookPayloadLoop,
90    HookPayloadMetadata, HookPhaseEvent, HookRunRequest, HookRunResult, HookSpec, HookStreamOutput,
91    HookSuspendMode, HooksConfig, ResolvedHookSpec, SUSPEND_STATE_SCHEMA_VERSION,
92    SuspendLifecycleState, SuspendStateRecord, SuspendStateStore, SuspendStateStoreError,
93};
94pub use instructions::InstructionBuilder;
95pub use landing::{LandingConfig, LandingError, LandingHandler, LandingResult};
96pub use loop_completion::{CompletionAction, CompletionError, LoopCompletionHandler};
97pub use loop_context::LoopContext;
98pub use loop_history::{HistoryError, HistoryEvent, HistoryEventType, HistorySummary, LoopHistory};
99pub use loop_lock::{LockError, LockGuard, LockMetadata, LoopLock};
100pub use loop_name::{LoopNameGenerator, LoopNamingConfig};
101pub use loop_registry::{LoopEntry, LoopRegistry, RegistryError};
102pub use memory::{Memory, MemoryType};
103pub use memory_store::{
104    DEFAULT_MEMORIES_PATH, MarkdownMemoryStore, format_memories_as_markdown, truncate_to_budget,
105};
106pub use merge_queue::{
107    MergeButtonState, MergeEntry, MergeEvent, MergeEventType, MergeOption, MergeQueue,
108    MergeQueueError, MergeState, SteeringDecision, merge_button_state, merge_execution_summary,
109    merge_needs_steering, smart_merge_summary,
110};
111pub use planning_session::{
112    ConversationEntry, ConversationType, PlanningSession, PlanningSessionError, SessionMetadata,
113    SessionStatus,
114};
115pub use preflight::{
116    AcceptanceCriterion, CheckResult, CheckStatus, PreflightCheck, PreflightReport,
117    PreflightRunner, extract_acceptance_criteria, extract_all_criteria, extract_criteria_from_file,
118};
119pub use preset_source::{
120    PresetRegistry, PresetSource, PresetSourceError, TomlPresetSource, YamlPresetSource,
121};
122#[cfg(feature = "recording")]
123pub use session_player::{PlayerConfig, ReplayMode, SessionPlayer, TimestampedRecord};
124#[cfg(feature = "recording")]
125pub use session_recorder::{Record, SessionRecorder};
126pub use skill::{SkillEntry, SkillFrontmatter, SkillSource, parse_frontmatter};
127pub use skill_registry::SkillRegistry;
128pub use summary_writer::SummaryWriter;
129pub use task::{Task, TaskStatus};
130pub use task_definition::{
131    TaskDefinition, TaskDefinitionError, TaskSetup, TaskSuite, Verification,
132};
133pub use task_store::TaskStore;
134pub use text::{floor_char_boundary, truncate_with_ellipsis};
135pub use urgent_steer::{UrgentSteerRecord, UrgentSteerStore};
136pub use wave_detection::{DetectedWave, detect_wave_events};
137pub use wave_prompt::{WaveWorkerContext, build_wave_worker_prompt};
138pub use wave_tracker::{CompletedWave, WaveFailure, WaveProgress, WaveResult, WaveTracker};
139pub use workspace::{
140    CleanupPolicy, TaskWorkspace, VerificationResult, WorkspaceError, WorkspaceInfo,
141    WorkspaceManager,
142};
143pub use worktree::{
144    SyncStats, Worktree, WorktreeConfig, WorktreeError, create_worktree, ensure_gitignore,
145    list_ralph_worktrees, list_worktrees, remove_worktree, sync_working_directory_to_worktree,
146    worktree_exists,
147};
ralph_core/lib.rs

ralph_core/
lib.rs
