Skip to content

xlflow completion ​

Generate shell completion scripts through Cobra.

Usage ​

bash
xlflow completion [bash|fish|powershell|zsh]

Options and Arguments ​

Option / argumentDescriptionDefault
bashGenerate Bash completion.-
fishGenerate Fish completion.-
powershellGenerate PowerShell completion.-
zshGenerate Zsh completion.-

Examples ​

bash
xlflow completion powershell > xlflow.ps1
xlflow completion bash > xlflow.bash

Notes ​

TIP

Completion generation is pure CLI output and does not require Excel COM.

When to use this command ​

Use xlflow completion 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.

Released under the MIT License.