start_command/
mod.rs

1//! start-command library
2//!
3//! Provides command execution with isolation, substitution, and failure handling.
4
5pub mod args_parser;
6pub(crate) mod docker_cleanup;
7pub mod execution_control;
8pub mod execution_store;
9pub mod failure_handler;
10pub mod isolation;
11pub mod isolation_metadata;
12pub mod log_uploader;
13pub mod output_blocks;
14pub mod sequence_parser;
15pub mod signal_handler;
16pub mod status_formatter;
17pub mod substitution;
18pub mod usage;
19pub mod user_manager;
20
21mod lino_value_json;
22mod local_hostname;
23
24// Re-export commonly used items
25pub use args_parser::{
26    generate_session_name, generate_uuid, get_effective_mode, has_isolation, is_valid_uuid,
27    parse_args, validate_options, ParsedArgs, WrapperOptions, VALID_BACKENDS, VALID_OUTPUT_FORMATS,
28    VALID_SHELLS,
29};
30pub use execution_control::{
31    collect_descendant_pids, collect_descendant_pids_with_runner, collect_process_ids,
32    collect_process_ids_with_runner, control_execution, control_execution_with_runner,
33    format_control_result_as_links_notation, get_control_command, parse_screen_pid,
34    CommandRunOutput, CommandRunner, ControlAction, ControlCommand, ExecutionControlResult,
35    SystemCommandRunner,
36};
37pub use execution_store::{
38    is_clink_installed, CleanupOptions, CleanupResult, ExecutionRecord, ExecutionRecordOptions,
39    ExecutionStats, ExecutionStatus, ExecutionStore, ExecutionStoreOptions,
40};
41pub use failure_handler::{handle_failure, Config as FailureConfig};
42pub use isolation::{
43    append_log_file, build_shell_with_args_cmd_args, create_log_footer, create_log_header,
44    create_log_path, create_log_path_for_execution, docker_image_exists, docker_pull_image,
45    get_default_docker_image, get_timestamp, is_command_available, is_interactive_shell_command,
46    is_shell_invocation_with_args, run_as_isolated_user, run_isolated, write_log_file,
47    IsolationOptions, IsolationResult, LogHeaderParams,
48};
49pub use isolation_metadata::{
50    build_isolation_options_map, docker_runtime_metadata, docker_runtime_status_lines,
51    docker_runtime_status_lines_for_options,
52};
53pub use log_uploader::upload_execution_log;
54#[allow(deprecated)]
55pub use output_blocks::{
56    // Timeline format API (formerly "status spine")
57    create_command_line,
58    create_empty_spine_line, // deprecated, use create_empty_timeline_line
59    create_empty_timeline_line,
60    create_finish_block,
61    create_spine_line, // deprecated, use create_timeline_line
62    create_start_block,
63    create_timeline_line,
64    create_timeline_separator,
65    create_virtual_command_block,
66    create_virtual_command_result,
67    escape_for_links_notation,
68    format_duration,
69    format_value_for_links_notation,
70    generate_isolation_lines,
71    get_result_marker,
72    parse_isolation_metadata,
73    FinishBlockOptions,
74    IsolationMetadata,
75    StartBlockOptions,
76    FAILURE_MARKER,
77    SPINE, // deprecated, use TIMELINE_MARKER
78    SUCCESS_MARKER,
79    TIMELINE_MARKER,
80};
81pub use signal_handler::{
82    clear_current_execution, get_signal_exit_code, set_current_execution, setup_signal_handlers,
83    was_signal_received,
84};
85pub use status_formatter::{
86    attach_current_time, enrich_detached_status, format_record, format_record_as_links_notation,
87    format_record_as_links_notation_with_current_time, format_record_as_text,
88    format_record_as_text_with_current_time, format_record_list,
89    format_record_list_as_links_notation, format_record_list_as_text,
90    format_record_with_current_time, is_detached_session_alive, list_executions, query_status,
91    read_exit_code_from_log, StatusQueryResult,
92};
93pub use substitution::{process_command, ProcessOptions, SubstitutionResult};
94pub use usage::print_usage;
95pub use user_manager::{
96    create_isolated_user, delete_user, get_current_user, get_current_user_groups, has_sudo_access,
97    CreateIsolatedUserOptions, DeleteUserOptions, UserOperationResult,
98};
start_command/mod.rs

start_command/
mod.rs
