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 args_parser_queries;
7pub mod detached_finalize;
8pub(crate) mod docker_cleanup;
9mod docker_network_lifecycle;
10pub mod docker_post_mortem;
11pub mod docker_recovery_options;
12pub mod docker_resource_limits;
13pub mod execution_attach;
14pub mod execution_control;
15pub mod execution_recovery;
16pub mod execution_resume;
17pub mod execution_resume_all;
18pub mod execution_store;
19pub mod exit_reason;
20pub mod failure_handler;
21pub mod isolation;
22pub mod isolation_metadata;
23pub mod log_uploader;
24pub mod output_blocks;
25pub mod query_commands;
26pub mod sequence_parser;
27pub mod session_probe;
28pub mod signal_handler;
29pub mod status_footer;
30pub mod status_formatter;
31pub mod status_probe;
32pub mod substitution;
33pub mod usage;
34pub mod user_manager;
35
36mod lino_value_json;
37mod local_hostname;
38
39// Re-export commonly used items
40pub use args_parser::{
41    generate_session_name, generate_uuid, get_effective_mode, has_isolation, is_valid_uuid,
42    parse_args, validate_options, ParsedArgs, WrapperOptions, VALID_BACKENDS, VALID_OUTPUT_FORMATS,
43    VALID_SHELLS,
44};
45pub use detached_finalize::{
46    build_detached_finalize_snippet, finalize_detached_execution, reconcile_finalized_record,
47    run_internal_finalize, DetachedFinalizeFacts, FinalizeOutcome,
48    END_TIME_SOURCE_DOCKER_FINISHED_AT, END_TIME_SOURCE_LOG_FOOTER, END_TIME_SOURCE_OBSERVED_AT,
49    INTERNAL_FINALIZE_FLAG, WATCHER_LOST_CONTAINER,
50};
51pub use docker_cleanup::{
52    build_detached_docker_completion_script, build_detached_docker_completion_script_with,
53    DockerContainerCleanupPolicy, DockerWatcherOptions,
54};
55pub use docker_post_mortem::{
56    build_docker_post_mortem_snippet, build_docker_removal_note_snippet,
57    build_docker_running_condition, build_docker_state_snippet,
58    build_docker_still_running_note_snippet, build_docker_wait_for_exit_snippet,
59    format_container_post_mortem, format_container_removal_note, format_lifetime,
60    normalize_docker_timestamp, ContainerPostMortem, DOCKER_RUNNING_INSPECT_FORMAT,
61    DOCKER_STATE_INSPECT_FORMAT, DOCKER_ZERO_TIME, LOG_CAPTURE_STOPPED_NOTE, POST_MORTEM_HEADER,
62    STILL_RUNNING_NOTE,
63};
64pub use execution_attach::{
65    attach_execution, attach_execution_with_runners, build_attach_plan,
66    format_attach_result_as_links_notation, AttachPlan, AttachResultFields, ExecutionAttachResult,
67    InteractiveRunner, SystemInteractiveRunner,
68};
69pub use execution_control::{
70    collect_descendant_pids, collect_descendant_pids_with_runner, collect_process_ids,
71    collect_process_ids_with_runner, control_execution, control_execution_with_runner,
72    format_control_result_as_links_notation, get_control_command, parse_screen_pid,
73    CommandRunOutput, CommandRunner, ControlAction, ControlCommand, ExecutionControlResult,
74    SystemCommandRunner,
75};
76pub use execution_resume::{
77    build_resume_plan, build_resumed_session_name, build_snapshot_image_name, resume_execution,
78    resume_execution_with, ExecutionResumeResult, ResumeHooks, ResumeMode, ResumePlan,
79    ResumeResultFields, SystemResumeHooks,
80};
81pub use execution_resume_all::{
82    format_resume_all, resume_all_executions, resume_all_executions_with, ExecutionResumeAllResult,
83    ResumeAllAction, ResumeAllEntry,
84};
85pub use execution_store::{
86    is_clink_installed, CleanupOptions, CleanupResult, ExecutionRecord, ExecutionRecordOptions,
87    ExecutionStats, ExecutionStatus, ExecutionStore, ExecutionStoreOptions,
88};
89pub use exit_reason::{
90    describe_exit_code, describe_exit_code_str, detect_exit_reason, resolve_exit_reason,
91    signal_name_for_exit_code, ExitCodeDescription,
92};
93pub use failure_handler::{handle_failure, Config as FailureConfig};
94pub use isolation::{
95    append_log_file, build_command_string, build_command_string_with, build_display_command,
96    build_shell_with_args_cmd_args, command_name, create_log_footer, create_log_header,
97    create_log_path, create_log_path_for_execution, docker_image_exists, docker_pull_image,
98    get_default_docker_image, get_timestamp, is_command_available, is_interactive_shell_command,
99    is_shell_invocation_with_args, quote_shell_arg, quote_shell_arg_with, run_as_isolated_user,
100    run_isolated, split_shell_words, split_shell_words_with, to_shell_words, write_log_file,
101    IsolationOptions, IsolationResult, LogHeaderParams, ShellQuotingStyle,
102};
103pub use isolation_metadata::{
104    build_isolation_options_map, docker_runtime_metadata, docker_runtime_status_lines,
105    docker_runtime_status_lines_for_options,
106};
107pub use log_uploader::upload_execution_log;
108#[allow(deprecated)]
109pub use output_blocks::{
110    // Timeline format API (formerly "status spine")
111    create_command_line,
112    create_empty_spine_line, // deprecated, use create_empty_timeline_line
113    create_empty_timeline_line,
114    create_finish_block,
115    create_spine_line, // deprecated, use create_timeline_line
116    create_start_block,
117    create_timeline_line,
118    create_timeline_separator,
119    create_virtual_command_block,
120    create_virtual_command_result,
121    escape_for_links_notation,
122    format_duration,
123    format_value_for_links_notation,
124    generate_isolation_lines,
125    get_result_marker,
126    parse_isolation_metadata,
127    FinishBlockOptions,
128    IsolationMetadata,
129    StartBlockOptions,
130    FAILURE_MARKER,
131    SPINE, // deprecated, use TIMELINE_MARKER
132    SUCCESS_MARKER,
133    TIMELINE_MARKER,
134};
135pub use query_commands::{dispatch_query_command, handle_cleanup, report_result, QueryOutcome};
136pub use session_probe::{probe_session, SessionProbe, SessionState};
137pub use signal_handler::{
138    clear_current_execution, get_signal_exit_code, set_current_execution, setup_signal_handlers,
139    was_signal_received,
140};
141pub use status_footer::{
142    parse_footer_from_tail, parse_footer_timestamp, read_footer_from_log, LogFooter,
143};
144pub use status_formatter::{
145    attach_current_time, enrich_detached_status, format_record, format_record_as_links_notation,
146    format_record_as_links_notation_with_current_time, format_record_as_text,
147    format_record_as_text_with_current_time, format_record_list,
148    format_record_list_as_links_notation, format_record_list_as_text,
149    format_record_with_current_time, list_executions, list_executions_filtered, query_status,
150    read_exit_code_from_log, StatusQueryResult,
151};
152pub use status_probe::is_detached_session_alive;
153pub use substitution::{process_command, ProcessOptions, SubstitutionResult};
154pub use usage::print_usage;
155pub use user_manager::{
156    create_isolated_user, delete_user, get_current_user, get_current_user_groups, has_sudo_access,
157    CreateIsolatedUserOptions, DeleteUserOptions, UserOperationResult,
158};
start_command/mod.rs

start_command/
mod.rs
