Skip to main content

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