Struct RunCommand 

pub struct RunCommand {

    pub dataflow: String,
    pub uv: bool,
    pub stop_after: Option<Duration>,
    pub log_level: LogLevelOrStdout,
    pub log_format: LogFormat,
    pub log_filter: Option<String>,
    pub allow_shell_nodes: bool,
    pub debug: bool,
    pub locked: bool,
    pub write_lockfile: bool,
    pub lockfile: Option<PathBuf>,
    pub working_dir: Option<PathBuf>,
    pub hub_override: Vec<String>,
    pub env: Vec<String>,
    pub exit_when_nodes_finish: Option<bool>,
}

Run a dataflow locally in isolation.

Spawns nodes in-process without a coordinator. CLI monitoring commands (dora list, dora stop, dora logs, …) do NOT attach to a dora run execution. Use dora up + dora start instead when you need to attach those tools or run multiple coordinated dataflows.

Fields

dataflow: String

Path to the dataflow descriptor file

uv: bool

stop_after: Option<Duration>

Automatically stop the dataflow after the given duration

The command will send a stop message after the specified time has elapsed, similar to pressing Ctrl-C. This gracefully stops all nodes in the dataflow.

Examples: –stop-after 30 # 30 seconds (a bare number is seconds) –stop-after 10s # 10 seconds –stop-after 5m # 5 minutes –stop-after 1h30m # 1 hour 30 minutes –stop-after 500ms # 500 milliseconds

log_level: LogLevelOrStdout

Minimum log level to display

Levels: error, warn, info, debug, trace, stdout (default). “stdout” shows everything including raw stdout from nodes.

log_format: LogFormat

Output format for log messages

json emits JSON Lines (one object per log message).

log_filter: Option<String>

Per-node log level filter

Format: “node1=level,node2=level”. Overrides –log-level for matched nodes.

Examples: –log-filter “sensor=debug,processor=warn”

allow_shell_nodes: bool

Allow shell nodes to execute arbitrary commands.

Shell nodes are disabled by default for security reasons. This flag sets the DORA_ALLOW_SHELL_NODES environment variable.

debug: bool

Enable debug mode (publishes all messages to Zenoh for topic echo/hz/info)

locked: bool

Use pinned git source commits from a lockfile during pre-run build.

write_lockfile: bool

Write resolved git source commits to a lockfile during pre-run build.

lockfile: Option<PathBuf>

Path to build lockfile (defaults to <dataflow-stem>.dora-lock.yaml).

working_dir: Option<PathBuf>

Decouples the working dir used for descriptor-relative paths from the dataflow file’s parent. Needed when the path passed in is a rewritten copy (e.g. dora record’s tempfile) whose parent can’t resolve the original build: / relative-path references.

hub_override: Vec<String>

Substitute a local checkout for a hub package (UC11 inner loop): --hub-override <namespace>/<name>=<path>. Same as dora build --hub-override; dora run is always local, so it applies directly.

env: Vec<String>

Set an environment variable for every node of this dataflow (repeatable). Merges into the dataflow-level env: block; node-level env: entries still win on conflict.

Under dora run nodes also inherit this process’s environment, but --env is the portable spelling that behaves identically under dora start (where nodes inherit the DAEMON’s environment instead). Applies at spawn time only; build: commands are unaffected. Values must survive the descriptor encoding verbatim: a literal $ is refused (the receiving process would expand it) and so are numeric-looking values that would be coerced.

exit_when_nodes_finish: Option<bool>

Exit once every node has finished, treating dora/timer/... inputs as a clock rather than as work.

By default a node is only told its inputs are closed when ALL of them are, and a timer input never closes — so a graph where any node consumes a timer cannot finish on its own, even after every worker has done its work. With this flag a node is finished once its DATA inputs have closed, which makes “run N items and exit” scriptable without wrapping the command in a timeout.

Nodes whose inputs are all timers are unaffected: they have no data dependency that could finish, so they are treated as sources, exactly as a node with no inputs is.

Overrides exit_when_nodes_finish: in the dataflow YAML in either direction: pass the flag to force it on, or --exit-when-nodes-finish=false to force it off for a descriptor that asks for it. Omit it entirely and the descriptor decides.

Implementations

impl Run

pub fn new(dataflow: String) -> Self

pub fn with_working_dir(self, working_dir: PathBuf) -> Self

Trait Implementations

impl Args for Run

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for Run

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

Formats the value using the given formatter.

impl Executable for Run

fn execute(self) -> Result<()>

impl FromArgMatches for Run

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.