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