Skip to main content

Module init

Module init 

Source
Expand description

Initialization command facade.

Purpose:

  • Expose the Ralph initialization workflow from a thin command module.

Responsibilities:

  • Re-export initialization options, result types, and README helpers.
  • Keep workflow orchestration, migration checks, and tests in focused companions.

Scope:

  • This module coordinates ralph init implementation only.
  • CLI parsing remains in crate::cli::init.

Usage:

  • Called by CLI handlers, tutorial flows, and integration tests.

Invariants/assumptions:

  • Interactive and non-interactive initialization share the same underlying workflow.
  • README and writer helpers remain delegated to dedicated submodules.

Re-exports§

pub use crate::constants::versions::README_VERSION;
pub use readme::ReadmeCheckResult;
pub use readme::ReadmeVersionError;
pub use readme::check_readme_current;
pub use readme::check_readme_current_from_root;
pub use readme::extract_readme_version;
pub use wizard::WizardAnswers;
pub use wizard::print_completion_message;
pub use wizard::run_wizard;
pub use writers::write_config;
pub use writers::write_done;
pub use writers::write_queue;

Modules§

gitignore
Gitignore management for Ralph initialization.
readme
README file version management for Ralph initialization.
wizard
Interactive onboarding wizard for Ralph initialization.
writers
File creation utilities for Ralph initialization.

Structs§

InitOptions
Options for initializing Ralph files.
InitReport

Enums§

FileInitStatus

Functions§

run_init