https://github.com/abbgrade/psdocker

Powershell Cmdlets that wrap the docker client and support the interaction with containers
https://github.com/abbgrade/psdocker

docker powershell powershell-module

Last synced: 3 months ago
JSON representation

Powershell Cmdlets that wrap the docker client and support the interaction with containers

• Host: GitHub
• URL: https://github.com/abbgrade/psdocker
• Owner: abbgrade
• License: mit
• Created: 2018-05-12T14:13:35.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-02-23T18:45:43.000Z (over 1 year ago)
• Last Synced: 2024-05-18T06:35:07.144Z (6 months ago)
• Topics: docker, powershell, powershell-module
• Language: PowerShell
• Homepage:
• Size: 224 KB
• Stars: 11
• Watchers: 2
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - abbgrade/psdocker - Powershell Cmdlets that wrap the docker client and support the interaction with containers (PowerShell)

README

        
# psdocker

[![.github/workflows/build-validation.yml](https://github.com/abbgrade/psdocker/actions/workflows/build-validation.yml/badge.svg?branch=develop)](https://github.com/abbgrade/psdocker/actions/workflows/build-validation.yml)

## Installation

Make sure that the docker cli is installed. e.g. from [Chocolatey](https://chocolatey.org/packages/docker-cli) or with [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows/).

Install psdocker from [PowerShell Gallery](https://www.powershellgallery.com/packages/psdocker) using a PowerShell command line:

    Install-Module -Name psdocker -Scope CurrentUser

## Build

This project uses a [build script](./psdocker.build.ps1) that is based on [Invoke-Build](https://github.com/nightroman/Invoke-Build).

For installation details see the instructions from the Invoke-Build project, but we recommend `Install-Module InvokeBuild -Scope CurrentUser`.

The documentation is based on [platyPS](https://github.com/PowerShell/platyPS), so you may want to execute `Install-Module PlatyPs -Scope CurrentUser`.

You can run the build by:

- __PowerShell__: execute `Invoke-Build` in a PowerShell in the directory of this project

- __VSCode__: run the integrated build task feature (F1 + "Tasks: Run Build Task")

## Test

This project uses test scripts using [Pester](https://github.com/pester/Pester).

For installation details see the instructions from the Pester project, but we recommend `Install-Module Pester -Scope CurrentUser`.

You can run the tests by:

- __PowerShell__: execute `Invoke-Build Test` in a PowerShell in the directory of this project

- __VSCode__: run the integrated test task feature (F1 + "Tasks: Run Test Task")

For debugging tests change the working directory to ./src/test create the breakpoint in VSCode and start debugging by F1 + "Debug: Start Debugging".

## Usage

See the folder [docs](./docs) for examples.

## Changelog

See the [changelog](./CHANGELOG.md) file.

## Contributors

- Steffen Kampmann

- Marc Kassay