Skip to content

shell-completion.md

Latest commit

 

History

History
49 lines (31 loc) · 1.66 KB

shell-completion.md

File metadata and controls

49 lines (31 loc) · 1.66 KB

Shell Completion

Enable tab completion for winapp in your terminal. Once activated, pressing Tab will suggest commands, options, and argument values as you type.

PowerShell

Run the following to print the registration script:

winapp complete --setup powershell

To activate, add the output to your PowerShell profile:

winapp complete --setup powershell >> $PROFILE

Then restart PowerShell (or run . $PROFILE to reload).

To try it in the current session without modifying your profile:

winapp complete --setup powershell | Out-String | Invoke-Expression

What it does

Registers a native argument completer that calls winapp complete on each Tab press, providing context-aware suggestions for commands, subcommands, options, and values.

Controls

  • Tab cycles through completions one at a time (default PowerShell behavior)
  • Ctrl+Space shows an interactive menu with descriptions: use arrow keys to navigate

To deactivate

Open your profile (notepad $PROFILE) and remove the Register-ArgumentCompleter block for winapp. Restart PowerShell.

What gets completed

  • Commands: winapp i + Tab → init
  • Subcommands: winapp cert + Tab → generate, install, info
  • Options: winapp init -- + Tab → --setup-sdks, --config-dir, --use-defaults, ...
  • Option values: Enum-based options suggest valid values when available
  • Node.js wrapper commands: node, node create-addon, etc. (when installed via npm)

Completions scale automatically — any new command or option added to the CLI is instantly completable with no additional setup.