Struct SessionLaunchSettings 

pub struct SessionLaunchSettings {
    pub language: Option<String>,
    pub settings: Option<Value>,
    pub agent_progress_summaries: Option<bool>,
    pub charter: Option<String>,
    pub delegation_preamble: Option<String>,
    pub extra_args: Vec<(String, Option<String>)>,
    pub force_new: bool,
    pub resume_kick: Option<String>,
    pub env_overrides: HashMap<String, String>,
}

Fields

language: Option<String>

settings: Option<Value>

agent_progress_summaries: Option<bool>

charter: Option<String>

Charter appended to the spawned claude subprocess’s system prompt via --append-system-prompt. Set for worker spawns (the LLM-supplied inline persona, via handle_spawn_worker) and for lead spawns (the lead charter, via apply_lead_charter); None only when the caller supplies none.

delegation_preamble: Option<String>

Lead-session delegation preamble: when Some, appended to the system prompt after the forge MCP trust block so a Lead session knows how to spawn and drive workers. Built by the workspace for Lead spawns only; None for workers.

extra_args: Vec<(String, Option<String>)>

Spawn-path-specific extra CLI args to thread through to the claude subprocess via OptionsBuilder::extra_arg. Each pair becomes --<flag> <value> (or --<flag> when the value is None). Workers in git-repo projects populate ("worktree", Some(label)) so claude forks a worktree at <repo>/.claude/worktrees/<label>/; lead/resume paths leave this empty.

force_new: bool

Boot-wave fresh-start routing flag (--new). When true, the project-target spawn arms skip resuming the catalog lead session and start a fresh one, and the lead cascades it to its workers. Pure workspace-side routing - #[serde(skip)] keeps it out of every serialized form, so it never reaches the settings JSON sent to claude. Defaults false; only the boot dispatch sets it.

resume_kick: Option<String>

The first turn a lead receives when this spawn carries a stored id to resume. The boot wave sets it so a restarted lead continues without a human prompt; the spawn delivers it only then, so a first boot or --new sends nothing. A resume the CLI refuses still takes the note, whose wording does not depend on history. Pure workspace-side routing - #[serde(skip)] keeps it out of every serialized form.

env_overrides: HashMap<String, String>

Per-spawn env overrides layered over the account env this session spawns under. A present key replaces, an absent key keeps, and a key mapped to an empty string removes the variable. Empty by default, which is exactly the previous behaviour: this is how per-spawn env reaches a respawned child without mutating the previous generation’s Agent.

Implementations

impl SessionLaunchSettings

pub const PERMISSIONS_KEY: &str = "permissions"

The permissions.defaultMode keys inside settings, shared by the workspace’s account stamp and the readers here so a rename cannot split the seam. The settings JSON is forge-internal - the CLI is driven by argv - so one const per key is the whole contract.

pub const PERMISSIONS_DEFAULT_MODE_KEY: &str = "defaultMode"

Trait Implementations

impl Clone for SessionLaunchSettings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionLaunchSettings

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

Formats the value using the given formatter.

impl Default for SessionLaunchSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionLaunchSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionLaunchSettings

impl PartialEq for SessionLaunchSettings

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SessionLaunchSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SessionLaunchSettings