Skip to content

xlflow type db ​

Manage generated TypeLib databases used by the VBA LSP.

Usage ​

bash
xlflow type db status
xlflow type db init
xlflow type db refresh
xlflow type db refresh --library all
xlflow type db clean

Options ​

OptionDescriptionDefault
--dirOverride the generated type DB directory.~/.xlflow/typelib
--libraryTypeLib library to import. Repeat, comma-separated, or use all for every known library present on this machine.excel
--forceDeprecated compatibility flag; refresh always regenerates.false

status reports manifest presence, the TypeDB catalog revision, generated files, library LIBID/version metadata, stale state, and the LSP database search order. The manifest's generator_version is informational; catalog revision changes control automatic regeneration.

init generates the database only when it does not already exist. refresh always regenerates the generated database, so it is the one-command equivalent of clean followed by init. clean deletes the generated database directory.

The default manual importer target is Excel. Use --library all to generate databases for every known library present on the machine, including Office, MSForms, Scripting, ADODB, VBIDE, Outlook, DAO/ACE DAO, MSXML, WinHTTP, Word, PowerPoint, Access, Windows Script Host, WMI Scripting, and VBScript RegExp. Direct keys for the expanded catalog are dao, msxml, winhttp, word, powerpoint, access, wsh, wmi, and vbscript-regexp. DAO prefers ACE DAO and falls back to DAO 3.6. Missing known libraries are skipped during all; arbitrary registered TypeLibs are not imported. Generated entries include TypeLib-derived ProgID mappings when registry metadata can be matched to TypeLib CoClass GUIDs, so the LSP can infer common late-bound expressions such as CreateObject("Excel.Application"), CreateObject("Scripting.FileSystemObject"), CreateObject("ADODB.Connection"), and CreateObject("Outlook.Application").

Generated entries are loaded by xlflow lsp when present. Missing or stale databases are automatically reconciled against the supported catalog on LSP startup; failures do not prevent fallback to the embedded built-in database.

When to use this command ​

Use xlflow type db 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.