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

//! Configuration file generation and validation.
//!
//! This module handles creating Ralph config files and PROMPT.md templates:
//! - Global config creation (`--init-global`)
//! - Local config creation (`--init-local-config`)
//! - Config validation (`--check-config`)
//! - PROMPT.md generation (`--init`)
//!
//! # Module Organization
//!
//! - [`global`] - Global config file creation
//! - [`local`] - Local config file creation
//! - [`validation`] - Config validation and error display (uses pure formatting functions)
//! - [`boundary`] - I/O boundary for PROMPT.md creation from templates
//!
//! All handlers accept a [`ConfigEnvironment`](crate::config::ConfigEnvironment) for
//! dependency injection, enabling tests to use in-memory storage instead of real filesystem.

//!
//! # Architecture Note
//!
//! The `validation.rs` module is in the `boundary/` subdirectory because it performs
//! I/O (printing). According to the Boundary-First Architecture pattern
//! from the refactoring plan, all I/O operations should be in boundary modules.
//!
//! The pure formatting functions in `validation_format.rs` are kept separate from the
//! I/O boundary functions in `validation.rs` to allow testing of formatting
//! logic without any I/O.

//!
//! See `docs/plans/2026-03-16-functional-rust-refactoring-plan.md` for details.

mod global;
mod local;
mod validation;

#[path = "boundary.rs"]
pub mod boundary;

// Re-export public API for external callers
pub use global::{handle_init_global, handle_init_global_with};
pub use local::{handle_init_local_config, handle_init_local_config_with};
pub use validation::{handle_check_config, handle_check_config_with};

pub fn handle_init_state_inference_with_env<R: crate::config::ConfigEnvironment>(
    config_path: &std::path::Path,
    prompt_path: &std::path::Path,
    template_arg: Option<&str>,
    colors: crate::logger::Colors,
    env: &R,
) -> anyhow::Result<bool> {
    boundary::handle_init_state_inference_with_env(
        config_path,
        prompt_path,
        template_arg,
        colors,
        env,
    )
}

pub fn handle_init_template_arg_at_path_with_env<R: crate::config::ConfigEnvironment>(
    template_name: &str,
    prompt_path: &std::path::Path,
    colors: crate::logger::Colors,
    env: &R,
) -> anyhow::Result<bool> {
    boundary::handle_init_template_arg_at_path_with_env(template_name, prompt_path, colors, env)
}