Skip to content

Source of Truth

For normal development, source files under src/ are the authority. Agents should edit files first, then run push, lint, test, and run.

The workbook can become newer than source when a user edits in Excel, when a session is dirty, or when a command intentionally mutates workbook state. In that case, run pull before editing source.

Use xlflow status to quickly check whether source, workbook, and session are in sync:

bash
xlflow status

If src_newer_than_workbook is true, run xlflow push. If the session is dirty, run xlflow save --session.

UserForms have two tracked concerns:

  • Designer structure: src/forms/specs/*.yaml
  • Code-behind: src/forms/code/*.bas in sidecar mode, or embedded .frm code in compatibility mode

Imported projects default to compatibility frm mode. Run xlflow form migrate sidecar when you want src/forms/specs/*.yaml and src/forms/code/*.bas to become the primary editing surface for existing UserForms.

Do not treat .frm / .frx files as the primary Designer source in sidecar mode. .frx files are binary companion artifacts, and .frm files remain generated artifacts used by xlflow workflows.

Released under the MIT License.