Skip to content

Vregime Workflow

Direct command workflow for vregime generation.

This module implements CLI workflow orchestration for its command family, including argument parsing, request construction, execution dispatch, and result presentation handoff.

Usage context

  • Command routing: Resolve CLI aliases and normalized command names.
  • Task execution: Build request objects and invoke registered tasks.
  • Output handling: Forward results to table, plot, export, or report flows.

Command: gen_template_vregime

Arguments

No command-specific arguments found.

Common Runtime and Presentation Arguments

These are shared workflow-level CLI flags added before command-specific options, covering runtime context (engine/input/storage) and output presentation/export behavior.

Flag Required Default Help Choices
--output No vregime.in Output vregime path. Example: --output vregime_custom.in, which writes the generated template using that filename.
--copy-to-dot No Also copy generated output to current directory. Example: --copy-to-dot, which keeps a convenience copy where you run the command.
--rows No 5 Number of sample rows. Example: --rows 8, which generates eight template data rows.
--run-id No Run identifier for run-scoped layout (e.g., run_91ac0e).
--project-root No Project root that contains inputs/, data/, analysis/, etc.
--analysis-id No Optional analysis artifact id; defaults to run id.