https://github.com/samneirinck/posh-docker

Powershell tab completion for Docker
https://github.com/samneirinck/posh-docker

docker powershell

Last synced: about 1 month ago
JSON representation

Powershell tab completion for Docker

• Host: GitHub
• URL: https://github.com/samneirinck/posh-docker
• Owner: samneirinck
• License: mit
• Created: 2015-11-11T19:47:18.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-29T19:39:17.000Z (over 6 years ago)
• Last Synced: 2024-05-23T00:31:45.064Z (8 months ago)
• Topics: docker, powershell
• Language: PowerShell
• Size: 152 KB
• Stars: 201
• Watchers: 10
• Forks: 23
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - samneirinck/posh-docker - Powershell tab completion for Docker (PowerShell)

README

        
# posh-docker

Powershell tab completion for Docker

>  :warning:

>

>  posh-docker is in maintenance mode only. There is no plan to support any new features, such as management commands.

> 

>  Alternatives exist, such as [DockerCompletion](https://github.com/matt9ucci/DockerCompletion), which provides a more extensive tab completion experience (requires PowerShell >= 5.0 and docker cli >= 1.13)

>

>  :warning:

[![Build status](https://ci.appveyor.com/api/projects/status/d4q4o9sdyvmm8yfh?svg=true)](https://ci.appveyor.com/project/samneirinck/posh-docker)

## Commands and options

All commands (`start`, `stop`, `run`, ...) and their options (`--attach`, `--cpuset-mems`, ...) are autocompleted.

![Command and option completion](img/command-option-completion.gif)

## Container and image names

Container and image names can be autocompleted. Type a command requiring a container or image name, press `` and the name will be completed.

![Container name completion](img/containername-completion.gif)

# Installation

*Prerequisite*

Verify that docker can be run from PowerShell. If the command is not found, you will need to add a docker alias or add the docker installation folder (e.g. `%ProgramFiles%\Docker Toolbox`) to your PATH environment variable.

## Windows 10 / Windows Server 2016 

1. Open a powershell prompt

2. Run `Install-Module -Scope CurrentUser posh-docker`

## Earlier Windows versions

1. Install [PackageManagement PowerShell Modules Preview](https://www.microsoft.com/en-us/download/details.aspx?id=49186)

2. Open a powershell prompt

3. Run `Install-Module -Scope CurrentUser posh-docker`

# Usage

After installation, execute the following line to enable autocompletion for the current powershell session:

`Import-Module posh-docker`

To make it persistent, add the above line to your profile. For example, run `notepad $PROFILE` and insert the line above.

# Updating

To update to the latest version of posh-docker, run the following command:

`Update-Module posh-docker`

# Credits

- Stuart Leeks: conversion to powershell module & general feedback.