DockerComposeCompletion for PowerShell

:memo: Are you looking for a completer for Compose V2 (docker compose)? If so, try the new version of DockerCompletion!

:memo: DockerComposeCompletion has been supporting V1 (docker-compose). I am considering whether the V2 should be supported or not. See the issue comments.

Requirements

• PowerShell >= 5.0
• docker-compose cli in $env:PATH

Quick Start

# Install from PowerShell Gallery
Install-Module DockerComposeCompletion -Scope CurrentUser
# Import
Import-Module DockerComposeCompletion

Less Quick Start (without Install-Module)

DockerComposeCompletion is a "well-formed" module. You can install and import it in the usual manner as follows.

Install

Download and place the DockerComposeCompletion directory and files in $env:PSModulePath.

You can see the paths listed in $env:PSModulePath as follows:

PS C:\> $env:PSModulePath -split ';'
C:\Users\matt9ucci\Documents\WindowsPowerShell\Modules
C:\Program Files\WindowsPowerShell\Modules
C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules

If your target path is C:\Users\matt9ucci\Documents\WindowsPowerShell\Modules, execute the following commands:

# Uninstall previous version
Remove-Item $HOME\Documents\WindowsPowerShell\Modules\DockerComposeCompletion -Recurse -Force
# Download
Invoke-WebRequest https://github.com/matt9ucci/DockerComposeCompletion/archive/master.zip -OutFile master.zip
# Unzip the downloaded archive
Expand-Archive master.zip
# Place the unzipped files and directory in $env:PSModulePath
Move-Item master\DockerComposeCompletion-master\DockerComposeCompletion "$HOME\Documents\WindowsPowerShell\Modules"
# Clean up
Remove-Item master.zip
Remove-Item master -Recurse -Force

$HOME is a PowerShell's automatic variable containing the full path of the user's home directory (in this case C:\Users\matt9ucci).

Import

Execute the following command to check if you can import DockerComposeCompletion:

PS> Get-Module -ListAvailable DockerComposeCompletion

    Directory: C:\Users\matt9ucci\Documents\WindowsPowerShell\Modules

ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Manifest   1.16.1.... DockerComposeCompletion

After the check, execute the following command to import the installed module:

Import-Module DockerComposeCompletion

Customization

You can add your own completers and modify default completers with your custom script.

For information about how to write custom scripts, see completers.ps1 and completers4arguments.ps1

To apply your custom script, pass the path as Import-Module's ArgumentList parameter:

Import-Module DockerComposeCompletion -ArgumentList pathto\custom1.ps1, pathto\custom2.ps1

Known Issues

In PowerShell 5.0/5.1, with one dash (-) and double dash (--), completers are not invoked because of a PowerShell's bug. It will be fixed in PowerShell 6.0.

A workaround for this issue is to type a character following - and --. For example, type --a and press tab.

Misc

This github repository will be often rebased.

Links

• PowerShell Gallery | DockerComposeCompletion