Skip to content

xlflow test

Discover and run workbook VBA test procedures.

Usage

bash
xlflow test [--filter <pattern>] [--session] [--keepalive]

Options and Arguments

Option / argumentDescriptionDefault
--filter <pattern>Run only matching test names.-
--sessionRun tests in the managed live workbook.false
--keepaliveReuse the bridge process.false
--jsonReturn structured test results.false

Examples

bash
xlflow test --json
xlflow test --filter Smoke --session --json

Notes

IMPORTANT

test executes VBA. Use a controlled workbook state before running tests that mutate sheets or files.

TIP

Keep VBA assertions simple and scalar so failures are easy for agents to parse.

JSON Output Example

Successful --json output uses the xlflow envelope plus command-specific fields.

json
{
  "status": "ok",
  "command": "test",
  "tests": [{ "name": "TestSmoke", "status": "pass" }],
  "summary": { "passed": 1, "failed": 0 }
}

Released under the MIT License.