xlflow attach

Validate that the active Excel workbook matches the configured workbook.

Deprecated

xlflow attach --active is deprecated. Use xlflow session attach when you want xlflow commands to operate on an already-open workbook.

Usage

xlflow attach --active

Options and Arguments

Option / argument	Description	Default
--active	Inspect the currently active workbook in Excel.	required
--json	Emit a machine-readable match result.	false

Examples

xlflow attach --active
xlflow attach --active --json

Notes

IMPORTANT

attach is a legacy safety check. It does not import source, change workbook state, or create a session for later commands.

attach uses the .NET bridge on Windows in auto mode.

TIP

Use xlflow session attach before manual Excel work when you want push, pull, run, inspect, or save to target the workbook that is already open.

JSON Output Example

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

{
  "status": "ok",
  "command": "attach",
  "active_workbook": "Book.xlsm",
  "matches_config": true
}

Related

• session
• doctor

When to use this command

Use xlflow attach when the task matches the command description above. For a goal-oriented workflow, start with the How-to guides and return here for exact options.

Prerequisites

Check the project configuration and run xlflow doctor --json before workbook-backed operations. Source-only commands can run without Excel; commands that read or mutate a workbook require Windows Excel and VBIDE access.

What this command reads and changes

The command reads the inputs and configuration described in its syntax and examples. Treat source files, the saved workbook, and a live session as separate states; add --session when the live workbook is authoritative. Any mutation is reversible only when a backup or explicit session save boundary exists.

Effect on source-of-truth state

Use xlflow status --json before and after the command. A source edit normally requires push; a workbook edit normally requires pull; a dirty live session requires save --session or an intentional discard.

Common workflows

Combine this command with the relevant source/workbook/session workflow, and use --json in scripts and agent loops.

Common failures

Read the structured error.code, exit code, and recovery metadata instead of scraping terminal text. The symptom-oriented troubleshooting guide maps installation, execution, session, VS Code, and WSL failures to recovery steps.