ralph-workflow 0.7.18

PROMPT-driven multi-agent orchestrator for git repos
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! File management utilities for Ralph's agent files.
//!
//! This module manages the `.agent/` directory structure and files:
//! - PLAN.md, ISSUES.md, STATUS.md, NOTES.md lifecycle
//! - commit-message.txt management
//! - PROMPT.md validation
//! - Isolation mode file cleanup
//! - File path extraction from ISSUES content
//! - File integrity verification and checksums
//! - Error recovery and state repair
//! - Real-time file system monitoring for PROMPT.md protection
//!
//! # Module Organization
//!
//! The files module is organized by domain concern:
//!
//! - [`protection`] - File protection and integrity (validation, integrity, monitoring)
//! - [`llm_output_extraction`] - LLM output extraction (commit message, JSON extraction)
//! - [`result_extraction`] - File path extraction from ISSUES content
//!
//! # Isolation Mode
//!
//! By default, Ralph operates in isolation mode where STATUS.md, NOTES.md,
//! and ISSUES.md are not persisted between runs. This prevents context
//! contamination from previous runs.
//!
//! # Orchestrator-Controlled File I/O
//!
//! The orchestrator is the sole entity responsible for writing output files.
//! Agent JSON output is extracted and written by the orchestrator, ensuring
//! consistent file handling regardless of agent behavior.

pub mod agent_files;
pub use self::agent_files::{
    cleanup_generated_files_with_workspace, delete_commit_message_file_with_workspace,
    delete_plan_file_with_workspace, ensure_files_with_workspace, file_contains_marker,
    file_contains_marker_with_workspace, read_commit_message_file_with_workspace,
    setup_xsd_schemas_with_workspace, write_commit_message_file_with_workspace, GENERATED_FILES,
};

pub mod backup;
pub use self::backup::{
    create_prompt_backup_with_workspace, make_prompt_read_only_with_workspace,
    make_prompt_writable_with_workspace, write_diff_backup_with_workspace,
};

pub mod context;
pub use self::context::{
    clean_context_for_reviewer_with_workspace, delete_issues_file_for_isolation_with_workspace,
    update_status_with_workspace,
};

pub mod integrity;
pub use self::integrity::{
    check_and_cleanup_xml_before_retry_with_workspace, check_filesystem_ready_with_workspace,
    check_xml_file_writable_with_workspace, cleanup_stale_xml_files_with_workspace,
    verify_file_not_corrupted_with_workspace, write_file_atomic_with_workspace,
};

pub mod monitoring;
pub mod protection;
pub use self::protection::{
    restore_prompt_if_needed, validate_prompt_md, validate_prompt_md_with_workspace,
};

pub mod recovery;
pub use self::recovery::{auto_repair_with_workspace, RecoveryStatus};

pub mod llm_output_extraction;

pub mod result_extraction;