docker / docker/cli

Unfriendly -p (--publish) syntax

Open
#2,324 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/networking area/ux kind/docs
Dominant language
Go
Stars
6.1k
Forks
2.2k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

It's difficult to understand docker run -p syntax. (TO:FROM). It took a while for me to realize where is the "from" part and where is the "to" part. This syntax is not described in help.
I think that it would be better for new users to create alternative syntax variant (FROM->TO). That syntax, in my opinion, is more user-friendly.
(copied from moby issue)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the Docker CLI implementation and help text for docker run -p and compare the documented TO:FROM syntax with the proposed FROM->TO variant. Check how published-port arguments are parsed and tested; done means the alternative syntax is accepted and clearly described in help without breaking the existing form.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.