Skip to content

Commit

Permalink
Improve help docs for ch create (#35)
Browse files Browse the repository at this point in the history
* Improve help docs for ch create 

This adds an example to the `--volume` command for easier reference.
  • Loading branch information
camerondurham authored Oct 29, 2022
1 parent 0180acd commit 1cbd0bb
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions cmd/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,29 @@ var (
Short: "create docker environment config",
Long: `Create docker environment config with new name.
You can use the following flag to replace an environment name if it already exists:
--replace Replace existing named environment, if one exists already.
You can use the following flag to replace an environment name if it already exists:
--replace Replace any existing environment with the same name
Will look for your Dockerfile in the current directory
if you do not explicitly set --file.
Will look for your Dockerfile in the current directory
if you do not explicitly set --file.
To create environment from a Dockerfile, use:
To create environment from a Dockerfile, use:
--file DOCKERFILE Path to Dockerfile. If context is used, filepath must be relative to that path.
--context PATH Context to use when building the Docker image
--file DOCKERFILE Path to Dockerfile. If context is used, filepath must be relative to that path.
--context PATH Context to use when building the Docker image
To create an environment from a pre-built Docker image, use:
To create an environment from a pre-built Docker image, use:
--image DOCKER_IMAGE
--image DOCKER_IMAGE
You can use the following options:
You can use the following options:
--volume list Bind mount a volume
--shell PATH Command to run for shell (i.e. /bin/sh, /bin/bash)
--cap-add CAPABILITY Add Linux capability (i.e. SYS_PTRACE)
--security-opt OPT Add security configuration (i.e. "seccomp=unconfined")
--port NUMBER Expose port from container to host
--privileged Give container extended privileges on host (use carefully!)
--volume HOST_PATH:CONTAINER_PATH Bind mount a volume (e.g. $PWD:/home )
--shell PATH Command to run for shell (e.g. /bin/sh, /bin/bash)
--cap-add CAPABILITY Add Linux capability (e.g. SYS_PTRACE)
--security-opt OPT Add security configuration (e.g. "seccomp=unconfined")
--port NUMBER Expose port from container to host
--privileged Give container extended privileges on host (use carefully!)
`,
Args: cobra.MinimumNArgs(1),
Version: rootCmd.Version,
Expand Down

0 comments on commit 1cbd0bb

Please sign in to comment.