Skip to content

runtime

Structs

  • RunInput - Lib-level input for [execute_run]. The CLI layer (in the firma

Functions


Struct

Lib-level input for [execute_run]. The CLI layer (in the firma host crate) builds this from its clap-derived args struct.

Fields:

  • profile: String - Built-in profile id to use.
  • config: Option<std::path::PathBuf> - Optional runtime config path (.toml, .yaml, .yml).
  • backend: Option<crate::backend::BackendKind> - Override backend selection.
  • sidecar_cli: crate::sidecar::SidecarCli - CLI value of --sidecar (local | <tcp://...|unix:///...> | unset).
  • capability_file: Option<std::path::PathBuf> - Optional capability token file path for runtime lease refresh.
  • identity_mode: Option<crate::config::SandboxIdentityMode> - Override sandbox identity mode.
  • preserve_host_user: bool - Preserve host user identity inside sandbox for compatibility workflows.
  • print_effective_config: bool - Print the resolved effective config as JSON before execution.
  • no_autostart: bool - When set, never autostart — fail with a typed error if the
  • sidecar_template_path: Option<std::path::PathBuf> - Optional explicit template path for the autostarted sidecar config.
  • sidecar_startup_timeout_secs: u64 - Seconds to wait for the autostarted sidecar’s ready line.
  • command: Vec<String> - Wrapped command and args.
  • authority_cli: crate::authority::AuthorityCli - CLI value of --authority (local | <url> | unset).
  • authority_profile: String - CLI value of --authority-profile. Default developer.
  • user_config_path: Option<std::path::PathBuf> - Optional override of the user-config path. Default

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> RunInput
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

Function

Execute firma run.

Returns an error when config resolution, backend lifecycle operations, or wrapped process supervision fails.

fn execute_run(args: &RunInput) -> Result<i32, crate::error::RunError>