vtcode_bash_runner/
lib.rs

1#![allow(
2    missing_docs,
3    dead_code,
4    unused_imports,
5    reason = "Intentional compatibility, platform, or test-only suppression."
6)]
7#![expect(
8    unused_results,
9    clippy::let_underscore_must_use,
10    clippy::indexing_slicing,
11    reason = "Process wrappers intentionally detach best-effort tasks, use OS process IDs, and configure commands through bounded builder APIs."
12)]
13//! Cross-platform command runner modeled after VT Code's original bash
14//! wrapper. The crate exposes a trait-based executor so downstream
15//! applications can swap the underlying process strategy (system shell,
16//! pure-Rust emulation, or dry-run logging) while reusing the higher-level
17//! helpers for workspace-safe filesystem manipulation.
18//!
19//! ## Modules
20//!
21//! - [`executor`] - Command execution strategies (process, dry-run, pure-rust)
22//! - [`runner`] - High-level `BashRunner` for workspace-safe operations
23//! - [`background`] - Background task management
24//! - [`pipe`] - Async pipe-based process spawning with unified handles
25//! - [`process`] - Process handle types for PTY and pipe backends
26//! - [`process_group`] - Process group management for reliable cleanup
27//! - [`stream`] - Stream utilities for reading output
28
29pub mod background;
30pub mod executor;
31pub mod pipe;
32pub mod policy;
33pub mod process;
34pub mod process_group;
35#[cfg(unix)]
36pub mod process_owner;
37pub mod runner;
38pub mod stream;
39
40// Background task management
41pub use background::{BackgroundCommandManager, BackgroundTaskHandle, BackgroundTaskStatus};
42
43// Executor variants
44#[cfg(feature = "dry-run")]
45pub use executor::DryRunCommandExecutor;
46#[cfg(feature = "exec-events")]
47pub use executor::EventfulExecutor;
48#[cfg(feature = "std-process")]
49pub use executor::ProcessCommandExecutor;
50#[cfg(feature = "pure-rust")]
51pub use executor::PureRustCommandExecutor;
52pub use executor::{CommandCategory, CommandExecutor, CommandInvocation, CommandOutput, CommandStatus, ShellKind};
53
54// Policy types
55pub use policy::{AllowAllPolicy, CommandPolicy, WorkspaceGuardPolicy};
56
57// Runner
58pub use runner::{BashRunner, RmOptions};
59
60// Stream utilities
61pub(crate) use stream::{ReadLineResult, read_line_with_limit};
62
63// Pipe-based process spawning (codex-rs compatible)
64pub use pipe::{
65    PipeSpawnOptions, PipeStdinMode, spawn_process as spawn_pipe_process,
66    spawn_process_no_stdin as spawn_pipe_process_no_stdin,
67    spawn_process_with_options as spawn_pipe_process_with_options,
68};
69
70// Process handle types (unified interface for PTY and pipe)
71pub use process::{
72    ChildTerminator, ExecCommandSession, ProcessHandle, PtyHandle, PtyHandles, SpawnedProcess, SpawnedPty,
73    collect_output_until_exit,
74};
75
76// Process group utilities
77pub use process_group::{
78    DEFAULT_GRACEFUL_TIMEOUT_MS, GracefulTerminationResult, KillSignal, detach_from_tty, graceful_kill_process_group,
79    graceful_kill_process_group_default, graceful_kill_process_group_default_async, kill_child_process_group,
80    kill_child_process_group_with_signal, kill_process_group, kill_process_group_by_pid,
81    kill_process_group_by_pid_with_signal, kill_process_group_with_signal, set_parent_death_signal, set_process_group,
82};
83
84#[cfg(windows)]
85pub use process_group::kill_process;
vtcode_bash_runner/lib.rs

vtcode_bash_runner/
lib.rs
