{"id":13596555,"url":"https://github.com/matt9ucci/DockerCompletion","last_synced_at":"2025-04-09T16:33:04.160Z","repository":{"id":47391465,"uuid":"100321126","full_name":"matt9ucci/DockerCompletion","owner":"matt9ucci","description":"Docker command completion for PowerShell.","archived":false,"fork":false,"pushed_at":"2024-12-15T09:20:01.000Z","size":342,"stargazers_count":381,"open_issues_count":1,"forks_count":68,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-12-15T10:26:20.500Z","etag":null,"topics":["docker"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matt9ucci.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-15T00:30:21.000Z","updated_at":"2024-12-15T09:20:05.000Z","dependencies_parsed_at":"2024-08-01T16:41:32.362Z","dependency_job_id":null,"html_url":"https://github.com/matt9ucci/DockerCompletion","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt9ucci%2FDockerCompletion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt9ucci%2FDockerCompletion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt9ucci%2FDockerCompletion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt9ucci%2FDockerCompletion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matt9ucci","download_url":"https://codeload.github.com/matt9ucci/DockerCompletion/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248067974,"owners_count":21042393,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker"],"created_at":"2024-08-01T16:02:34.195Z","updated_at":"2025-04-09T16:32:59.151Z","avatar_url":"https://github.com/matt9ucci.png","language":"PowerShell","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"readme":"# DockerCompletion for PowerShell\n\n![demo](demo.gif)\n\n* Many completions (probably much more than you imagine :smiley:)\n* Automatic detection of aliases [like `d`](#i-use-alias-d-for-docker-does-the-completion-work-for-the-alias) and others\n* Wild card (`*`) support\n* [Customizable](#customization)\n* Contributions welcome!\n\n## Requirements\n* PowerShell \u003e= 5.0\n* docker cli \u003e= 1.13 in `$env:PATH`\n\n### Optional\n* [Compose v2](https://github.com/docker/compose)\n\n  It is used for `docker compose` completion.\n  The supported version will be bumped up frequently.\n  For information about it, see the comment of [Compose/completers.ps1](DockerCompletion/Compose/completers.ps1).\n\n## Installation\n\n```powershell\n# Install from PowerShell Gallery\nInstall-Module DockerCompletion -Scope CurrentUser\n# Import\nImport-Module DockerCompletion\n```\n\nDon't forget to execute the `Import-Module` command every time you start a new PowerShell session. You can do it automatically [by using PowerShell profile](#how-can-i-execute-import-module-automatically).\n\n### Other methods\n\n\u003cdetails\u003e\n\u003csummary\u003eGit\u003c/summary\u003e\n\n```powershell\n# Shallow clone from GitHub\ngit clone --depth 1 https://github.com/matt9ucci/DockerCompletion\n# Import\nImport-Module ./DockerCompletion/DockerCompletion\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eAs a \"well-formed\" module\u003c/summary\u003e\n\nDockerCompletion is a \"well-formed\" module.\nYou can install and import it in the usual manner as follows.\n\n#### Install\n\nDownload and place the [DockerCompletion directory and files](./DockerCompletion) in `$env:PSModulePath`.\n\nYou can see the paths listed in `$env:PSModulePath` as follows:\n```powershell\nPS C:\\\u003e $env:PSModulePath -split ';'\nC:\\Users\\matt9ucci\\Documents\\WindowsPowerShell\\Modules\nC:\\Program Files\\WindowsPowerShell\\Modules\nC:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\n```\n\nIf your target path is `C:\\Users\\matt9ucci\\Documents\\WindowsPowerShell\\Modules`, execute the following commands:\n\n```powershell\n# Uninstall previous version\nRemove-Item $HOME\\Documents\\WindowsPowerShell\\Modules\\DockerCompletion\\ -Recurse -Force\n# Download\nInvoke-WebRequest https://github.com/matt9ucci/DockerCompletion/archive/master.zip -OutFile master.zip\n# Unzip the downloaded archive\nExpand-Archive master.zip\n# Place the unzipped files and directory in $env:PSModulePath\nMove-Item master\\DockerCompletion-master\\DockerCompletion\\ \"$HOME\\Documents\\WindowsPowerShell\\Modules\\\"\n# Clean up\nRemove-Item master.zip\nRemove-Item master -Recurse -Force\n```\n\n`$HOME` is a PowerShell's automatic variable containing the full path of the user's home directory (in this case `C:\\Users\\matt9ucci`).\n\n#### Import\n\nExecute the following command to check if you can import DockerCompletion:\n\n```powershell\nPS C:\\\u003e Get-Module -ListAvailable DockerCompletion\n\n    Directory: C:\\Users\\matt9ucci\\Documents\\WindowsPowerShell\\Modules\n\nModuleType Version    Name                                ExportedCommands\n---------- -------    ----                                ----------------\nManifest   1.2010.... DockerCompletion\n```\n\nAfter the check, execute the following command to import the installed module:\n\n```powershell\nImport-Module DockerCompletion\n```\n\n\u003c/details\u003e\n\n## Customization\n\nYou can add your own completers and modify default completers with your custom script.\n\nFor information about how to write custom scripts, see [completers.ps1](DockerCompletion/completers.ps1) and [completers4arguments.ps1](DockerCompletion/completers4arguments.ps1)\n\nTo apply your custom script, pass the path as `Import-Module`'s ArgumentList parameter:\n```powershell\nImport-Module DockerCompletion -ArgumentList pathto\\custom1.ps1, pathto\\custom2.ps1\n```\n\n## Known Issues\nIn PowerShell 5.0/5.1, with one dash (`-`) and double dash (`--`), completers are not invoked because of [a PowerShell's bug](https://github.com/PowerShell/PowerShell/issues/2912).\nIt will be [fixed in PowerShell 6.0](https://github.com/PowerShell/PowerShell/pull/3633).\n\nA workaround for this issue is to type a character following `-` and `--`.\nFor example, type `--a` and press tab.\n\n## FAQ\n\n### How can I execute `Import-Module` automatically?\n\nUse [PowerShell profile](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles).\nFor example, run the following commands:\n\n```powershell\n# Create your profile\nNew-Item $PROFILE -ItemType File -Force\n# Add the import command to the profile\nAdd-Content $PROFILE 'Import-Module DockerCompletion'\n```\n\nWhenever you start a new PowerShell session, the commands in the `$PROFILE` are executed each time.\n\n### I use alias `d` for `docker`. Does the completion work for the alias?\n\nYes, it does. DockerCompletion detects aliases for `docker` when executing `Import-Module`.\nFor example:\n\n```powershell\n# Set the alias `d` for `docker`\nSet-Alias d docker\n# Detect the alias `d` and register completers for both `docker` and `d`\nImport-Module DockerCompletion\n```\n\n## Misc\n\nThis github repository will be often rebased.\n\n## Links\n\n* [PowerShell Gallery | DockerCompletion](https://www.powershellgallery.com/packages/DockerCompletion)\n* [docker/cli](https://github.com/docker/cli)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatt9ucci%2FDockerCompletion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatt9ucci%2FDockerCompletion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatt9ucci%2FDockerCompletion/lists"}