Skip to main content

WorktreeConfig

Struct WorktreeConfig 

Source
pub struct WorktreeConfig {
Show 13 fields pub enabled: bool, pub base_ref: WorktreeBaseRef, pub default_branch: String, pub root: String, pub branch_prefix: String, pub prune_branch_on_remove: bool, pub cleanup_on_completion: bool, pub bg_isolation: BgIsolation, pub git_timeout_secs: u64, pub max_worktrees: Option<usize>, pub disk_quota_mb: Option<u64>, pub auto_reconcile_secs: u64, pub reconcile_on_startup: bool,
}
Expand description

Configuration for the per-subagent git worktree isolation feature.

When enabled = true, each subagent that opts in via SubAgentPermissions::worktree receives a dedicated git worktree on a fresh branch, ensuring that file edits from concurrent agents do not interfere with each other or with the main working tree.

§Examples

use zeph_config::WorktreeConfig;

let cfg = WorktreeConfig::default();
assert!(!cfg.enabled);
assert_eq!(cfg.root, ".claude/worktrees");
assert_eq!(cfg.branch_prefix, "agent/");
assert_eq!(cfg.git_timeout_secs, 30);

Fields§

§enabled: bool

Enable per-subagent git worktrees. When false, no worktrees are created regardless of other settings.

§base_ref: WorktreeBaseRef

Base commit strategy for new worktree branches.

§default_branch: String

Default remote branch used when base_ref = "fresh".

Empty string triggers auto-detection of origin/HEAD.

§root: String

Root directory for worktrees, relative to the repository root.

Each worktree is placed in a subdirectory named after the subagent ID.

§branch_prefix: String

Branch name prefix. The full branch name is "{prefix}{subagent_id}".

§prune_branch_on_remove: bool

Delete the worktree branch after the worktree is removed.

When false (default), the branch persists so the agent’s work can be reviewed, merged, or discarded manually.

§cleanup_on_completion: bool

Remove the worktree when the agent completes or is cancelled.

When false, worktrees persist until an explicit worktree clean command.

§bg_isolation: BgIsolation

Background subagent isolation mode.

Controls whether background subagents receive a dedicated worktree or edit the working copy directly.

§git_timeout_secs: u64

Per-command timeout for git invocations, in seconds.

Applied to every git call issued by the worktree subsystem (e.g. git worktree add, git fetch, git rev-parse). Increase this value on repositories that are slow to clone or when running over high-latency network links. A value of 0 is clamped to 1 second by DefaultGitRunner, not by any call site.

§max_worktrees: Option<usize>

Maximum number of concurrent worktrees under root. None (default) means unlimited.

Enforced as a creation-time admission cap: a create() call that would push the count of git-registered secondary worktrees to max_worktrees or beyond fails with WorktreeError::QuotaExceeded instead of silently growing disk usage. The count includes worktrees created by other, concurrently running zeph sessions over the same rootmax_worktrees bounds total disk-safe usage under the repository, not just this session’s own worktrees. The check is a best-effort soft cap: it is not atomic across processes, so two concurrent create() calls can both pass and briefly exceed the configured maximum by a small margin. Lowering this value below the current worktree count does not evict existing worktrees; it only blocks new admissions until an operator runs zeph worktree clean or raises the limit. A value of Some(0) is rejected at config-validation time (it would block all worktree creation).

§disk_quota_mb: Option<u64>

Soft total-disk-usage threshold, in megabytes, across all worktrees under root. None (default) disables disk accounting.

When exceeded, the reconcile sweep (startup and/or periodic, see auto_reconcile_secs / reconcile_on_startup) emits a warning status indicator and auto-reclaims only git-prunable entries — an intact worktree is never force-removed to satisfy this threshold. The reported total is a sum of logical file sizes (metadata().len()), not on-disk block usage; content shared via hardlinks across worktrees (e.g. zeph-session blobs) can be double-counted, so treat the total as an approximation, not exact du output. A value of Some(0) is rejected at config-validation time (it would leave every non-empty worktree permanently over quota).

§auto_reconcile_secs: u64

Interval, in seconds, for the supervised background reconcile-and-quota sweep. 0 (default) disables the periodic sweep.

When greater than zero, one task is registered with the session TaskSupervisor that, on this cadence, reconciles the git worktree registry, auto-reclaims prunable entries via the same path as zeph worktree clean (non-force), and evaluates max_worktrees / disk_quota_mb. Each tick may perform a filesystem walk of every worktree (potentially multi-gigabyte target/ directories), so a short interval is wasteful; an hourly cadence (3600) is a reasonable default when enabling this. Config::validate rejects any value in 1..60 — a sub-minute interval would run a full filesystem walk in a tight loop.

§reconcile_on_startup: bool

Run one reconcile-and-quota sweep at bootstrap, immediately after the worktree manager is constructed. Default true.

Recovers from a crash that left prunable worktrees behind without waiting for the first periodic tick, and evaluates disk_quota_mb / max_worktrees once per launch even when auto_reconcile_secs = 0 — without this, a disk_quota_mb set by itself would never be evaluated at all. Config::validate rejects disk_quota_mb.is_some() combined with both this field false and auto_reconcile_secs == 0, so that exact inert combination cannot reach a running session. Safe by construction: the startup sweep only ever removes entries git itself reports as prunable (directory or gitdir-link already gone), identical to zeph worktree clean without --force.

Trait Implementations§

Source§

impl Clone for WorktreeConfig

Source§

fn clone(&self) -> WorktreeConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WorktreeConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for WorktreeConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for WorktreeConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for WorktreeConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more