{"id":13416526,"url":"https://github.com/Microsoft/Docker-PowerShell","last_synced_at":"2025-03-15T00:31:04.431Z","repository":{"id":65975363,"uuid":"55193381","full_name":"microsoft/Docker-PowerShell","owner":"microsoft","description":"PowerShell Module for Docker","archived":true,"fork":false,"pushed_at":"2018-04-27T17:13:50.000Z","size":343,"stargazers_count":288,"open_issues_count":20,"forks_count":86,"subscribers_count":70,"default_branch":"master","last_synced_at":"2025-03-13T01:20:48.613Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/microsoft.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}},"created_at":"2016-04-01T01:01:11.000Z","updated_at":"2024-12-21T16:08:20.000Z","dependencies_parsed_at":"2023-02-19T18:45:29.981Z","dependency_job_id":null,"html_url":"https://github.com/microsoft/Docker-PowerShell","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDocker-PowerShell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDocker-PowerShell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDocker-PowerShell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDocker-PowerShell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/Docker-PowerShell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243667692,"owners_count":20328032,"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":[],"created_at":"2024-07-30T21:01:00.202Z","updated_at":"2025-03-15T00:31:04.021Z","avatar_url":"https://github.com/microsoft.png","language":"C#","readme":"# THIS MODULE HAS BEEN DEPRECATED\n\n\u003e Please note that due to low usage this module is no longer being actively maintained. It is recommended to use either the `Docker cli (docker.exe)` or try [Docker.DotNet](https://github.com/Microsoft/Docker.DotNet) directly.\n\n---\n\n# PowerShell for Docker\n\nThis repo contains a PowerShell module for the [Docker Engine](\nhttps://github.com/docker/docker/). It can be used as an alternative to the\nDocker command-line interface (`docker`), or along side it. It can target a\nDocker daemon running on any operating system that supports Docker, including\nboth Windows and Linux.\n\nNote that this module is still in alpha status and is likely to change rapidly.\n\n## Dependencies\n* Windows, Windows Server, Nano Server, or PowerShell 6 supported host.\n* PowerShell 5 (available in Windows 10, Server 2016 Preview, or by installing\n  [WMF 5](https://www.microsoft.com/en-us/download/details.aspx?id=50395)) or\n  [PowerShell 6 Preview](https://github.com/powershell/powershell) (available for Windows, Linux, and Mac OS X)\n* A recent Docker endpoint, running either locally or on a remote machine.\n  [Container Quick Start for Windows Server](https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_server)\n  [Container Quick Start for Windows 10](https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_10)\n\nNote that there is no dependency on the Docker client.\n\nCurrently, the Docker endpoint must support API version 1.24, which is still in\ndevelopment. Practically speaking, this means you will need a development build\nof Docker. If your Docker endpoint is running on Windows Server Technical Preview\n5, that should be new enough.\n\n## Installation\nSee our [Releases](https://github.com/Microsoft/Docker-PowerShell/releases) page for current releases\nof Docker PowerShell, or you can try the development builds below. Feedback and\ncontributions welcome!\n\n### Development Builds\n\n![build status](https://ci.appveyor.com/api/projects/status/ysh1lrw8fxjjylpo/branch/master)\n\nThe following information will allow you to install development builds -- do\nunderstand that these are early builds and will change (hopefully with your\nfeedback).\n\nThe dev builds are updated for every commit to master and are released to\nhttps://ci.appveyor.com/nuget/docker-powershell-dev. To install the latest\nbuild, in PowerShell 5.0 run:\n\n    \u003e Register-PSRepository -Name DockerPS-Dev -SourceLocation https://ci.appveyor.com/nuget/docker-powershell-dev\n\n    \u003e Install-Module -Name Docker -Repository DockerPS-Dev -Scope CurrentUser\n(Note: if you get an error like \"WARNING: MSG:SourceLocationNotValid\" try updating your Nu-Get version as explained in [this issue comment](https://github.com/Microsoft/Docker-PowerShell/issues/62#issuecomment-221659534).)\n\nAfter this, you can update to new development builds with just:\n\n    \u003e Update-Module -Name Docker\n\n#### Linux and Mac OS X\n\nAs of the [v6.0.0-alpha.10](https://github.com/PowerShell/PowerShell/releases/tag/v6.0.0-alpha.10) release of PowerShell, the instructions\nlisted above for development builds work as expected on Linux.\n\n#### Need an offline workflow?\n\nFrom an internet connected machine:\n\n    \u003e Save-Module -Name Docker -Path .\n\nCopy the entire folder `.\\Docker` to the destination at: `%ProgramFiles%\\WindowsPowerShell\\Modules`\n\n## Contributions\nWe welcome contributions to this project in the form of issues (bugs,\nsuggestions, proposals, etc.) and pull requests.\n\nFor pull requests, we do require that you sign the [Microsoft Contribution\nLicense Agreement](https://cla.microsoft.com/). It is a simple process that you\nonly need to complete once.\n\nThis project has adopted the [Microsoft Open Source Code of\nConduct](https://opensource.microsoft.com/codeofconduct/). For more information\nsee the [Code of Conduct\nFAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact\n[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional\nquestions or comments.\n\n## Compilation\n### Before Compiling: Git submodules for Docker.DotNet\nThis project uses Docker.DotNet as a git submodule (`git submodule --help` to\nview manual pages for submodule).  When first starting a new clone of\nDocker.Powershell, this requires one-time initializtion of the submodule with\n`git submodule update --init` to prepare the directories used by the\nsubmodule. When making changes to Docker.PowerShell that use corresponding\nchanges made to Docker.DotNet master branch, use `git submodule update --remote`\nto sync the submodule to the latest in master, and include the updated commit id\nfor the submodule in the changes submitted to Docker.Powershell.\n\n### Compiling with DotNet CLI\nTo compile this project, you need the following:\n* A recent build of the [.NET Core SDK](https://github.com/dotnet/cli/releases)\n* The .NET 4.6 and 4.5 SDKs. You get these either by:\n  * Installing Visual Studio 2015 or\n  * Downloading the [.NET 4.6 Targeting\nPack](https://www.microsoft.com/en-us/download/details.aspx?id=48136)\nand the [Windows SDK for Windows 8 with .NET Framework 4.5](https://developer.microsoft.com/en-us/windows/downloads/windows-8-sdk)\n\nOnce these are installed, you can run:\n\n    \u003e dotnet restore\n\n    \u003e dotnet publish .\\src\\Docker.PowerShell -o .\\src\\Docker.PowerShell\\bin\\Module\\Docker -f net46\n\nor for a module targetted at cross-platform PowerShell:\n\n    \u003e dotnet restore\n\n    \u003e dotnet publish .\\src\\Docker.PowerShell -o .\\src\\Docker.PowerShell\\bin\\Module\\Docker -f netstandard1.6\n\nThis will produce the PowerShell module at\n`.\\src\\Docker.PowerShell\\bin\\Module\\Docker` in the project folder.\n\nYou will only need to run `dotnet restore` once unless you pull changes that\nupdate the project dependencies in project.json.\n\n### Updating Help Markdown Files\nThis codebase includes markdown files corresponding to the help information for\neach of the cmdlets. This markdown is generated and consumed by the\n[platyPS PowerShell module](https://github.com/PowerShell/platyPS). You should use\nthe platyPS cmdlets to update and refresh the markdown files to reflect any changes\nmade to the structure or behavior of the cmdlets.  Follow the instructions on the\nplatyPS github readme to get the module installed, and then after imported the\nDocker module with your changes compiled in, run:\n\n    \u003e New-MarkdownHelp -Module Docker -OutputFolder .\\src\\Docker.Powershell\\Help -ErrorAction SilentlyContinue\n\n    \u003e Update-MarkdownHelp -Path .\\src\\Docker.PowerShell\\Help\n\nThis will create new entries for any added parameters in existing cmdlets, as well as\nnew markdown files for any new cmdlets, leaving placeholder text for the descriptions\nand examples. Please keep the descriptions of any existing or new parameters or cmdlets\nup-to-date with any changes to the implementation.\n\n### Visual Studio Code\nIf you use [Visual Studio Code](https://code.visualstudio.com/) as your editor,\nyou will find three tasks pre-defined in the top-level directory:\n* `restore` will perform `dotnet restore` across the whole project to reload any\n  dependencies.\n* `build` will perform the `dotnet publish` command with the arguments listed in\n  the compilation section above.\n* `test` will launch a new powershell window with the module loaded for manual\n  testing.\n* `update-help` will use powershell to run the New-MarkdownHelp and\n  Update-MarkdownHelp cmdlets with the arguments necessary to generate any\n  updates to the help markdown files. NOTE: This requires the platyPS module\n  and uses the most recently built local Docker module.\n","funding_links":[],"categories":["Development with Docker","Dev Tools"],"sub_categories":["API Client"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMicrosoft%2FDocker-PowerShell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMicrosoft%2FDocker-PowerShell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMicrosoft%2FDocker-PowerShell/lists"}