Getting Started
xlflow turns an Excel VBA workbook into a source-controlled project that can be edited, checked, and executed from the command line.
Requirements
- Windows
- Microsoft Excel
- PowerShell
- Trust access to the VBA project object model enabled in Excel
Commands that only inspect source files, such as lint and analyze, can run without Excel. Workbook-backed commands use Excel COM.
Create a project
Create a new macro-enabled workbook:
bash
xlflow new Book.xlsmOr initialize from an existing workbook:
bash
xlflow init Book.xlsmInstall the bundled agent skill during scaffolding when you want an AI coding agent to follow xlflow workflows:
bash
xlflow new Book.xlsm --with-skill --agent codexFirst workflow
bash
xlflow doctor --json
xlflow pull --json
xlflow lint --json
xlflow macros --json
xlflow run Main.Run --headless --jsonUse xlflow session start for repeated edit loops so Excel and the configured workbook stay open between commands.