update the CLI references

Signed-off-by: Wang Xu <[email protected]>

Author: gnawux

Diff for: reference/attach.md

@@ -1,9 +1,13 @@
 # attach
 
-Attach a specified container in a Pod to TTY
+Attach to the input/output of a specified container
 
-	Usage:
-	  hyperctl attach CONTAINER
+```
+Usage:
+  hyperctl attach CONTAINER
 
-	Help Options:
-	  -h, --help  Show this help message
+Attach to the input/output of a specified container
+
+Help Options:
+  -h, --help  Show this help message
+```

Diff for: reference/cli.md

@@ -2,33 +2,33 @@
 
 ```
 Usage:
-
-	hyperctl [OPTIONS] COMMAND [ARGS...]
+  hyperctl [OPTIONS] COMMAND [ARGS...]
 
 Command:
-
-    attach                 Attach to the tty of a specified container in a Pod
-    build                  Build an image from a Dockerfile
-    commit                 Create a new image from a container's changes
-    create                 Create a Pod into 'pending' status, but without running it
-    exec                   Run a command in a container of a running Pod
-    images                 List images
-    info                   Display system-wide information
-    list                   List all Pods or containers
-    login                  Register or log in to a Docker registry server
-    logout                 Log out from a Docker registry server
-    pull                   Pull an image from a Docker registry server
-    push                   Push an image or a repository to a Docker registry server
-    replace                (Linux only) replace the Pod in a running VM with a new one
-    rm                     Remove one or more Pods
-    rmi                    Remove one or more images
-    run                    Create a Pod, and launch a new Pod
-    start                  Launch a 'pending' Pod
-    stop                   Stop a running Pod, it will become 'pending'
+  attach                 Attach to the input/output of a specified container
+  build                  Build an image from a Dockerfile
+  commit                 Create a new image from a container's changes
+  create                 Create a pod or create a container in a pod
+  exec                   Run a command in a specified container
+  images                 List images
+  info                   Display system-wide information
+  list                   List all pods or containers
+  load                   Load a image from STDIN or tar archive file
+  login                  Register or log in to a Docker registry server
+  logout                 Log out from a Docker registry server
+  pause                  Pause a running pod
+  pull                   Pull an image from a Docker registry server
+  push                   Push an image or a repository to a Docker registry server
+  rm                     Remove one or more pods or containers
+  rmi                    Remove one or more images
+  run                    Create a pod, and launch the new pod
+  save                   Save one or more images to a tar archive (streamed to STDOUT by default)
+  start                  Start a pod or container
+  stop                   Stop a running pod or container
+  unpause                Unpause a paused pod
 
 Help Options:
-
-    -h, --help             Show this help message
+  -h, --help             Show this help message
 
 Run 'hyperctl COMMAND --help' for more information on a command.
 ```

Diff for: reference/create.md

@@ -1,9 +1,31 @@
 # create
 
-Define a Pod and allocate storage, but without starting it. The Pod will stay in `Created` state.
+Create a pod or create a container in a pod.
 
-	Usage:
-	  hyperctl create POD_FILE
+```
+Usage:
+  hyperctl create [OPTIONS] [POD_ID] IMAGE [COMMAND] [ARG...]
 
-	Help Options:
-	  -h, --help  Show this help message
+Create a pod, or create a container in the pod specified by the POD_ID
+
+Application Options:
+  -p, --podfile=""       read spec from the pod file instead of command line
+  -y, --yaml             pod file in Yaml format instead of JSON
+      --name=""          Assign a name to the container
+      --workdir=""       Working directory inside the container
+  -t, --tty              the run command in tty, such as bash shell
+      --cpu=1            CPU number for the VM (default: 1)
+      --memory=128       Memory size (MB) for the VM (default: 128)
+      --env=[]           Set environment variables
+      --entrypoint=""    Overwrite the default ENTRYPOINT of the image
+      --restart=""       Restart policy to apply when a container exits (never, onFailure, always) (default: never)
+      --log-driver=""    Logging driver for Pod
+      --log-opt=         Log driver options
+      --publish=[]       Publish a container's port to the host, format: --publish [tcp/udp:]hostPort:containerPort
+      --label=[]         Add labels for Pod, format: --label key=value
+  -v, --volume=[]        Mount host file/directory as a data file/volume, format: -v|--volume=[[hostDir:]containerDir[:options]]
+  -c, --container        Create container inside a pod
+
+Help Options:
+  -h, --help             Show this help message
+```

Diff for: reference/exec.md

@@ -2,12 +2,17 @@
 
 Run a command in a container or a Pod, and attach the current terminal to the command stdio.
 
-	Usage:
-	  hyperctl exec [OPTIONS] POD_ID:CONTAINER_NAME COMMAND [ARGS...]
+```
+Usage:
+  hyperctl exec [OPTIONS] POD|CONTAINER COMMAND [ARGS...]
 
-	Help Options:
-	  -h, --help            Show this help message
-	  -t                    Allocate a pseudo-TTY
+Run a command in a container or a Pod
 
-    Example:
-      hyperctl exec pod-3uhg23po:nginx echo "Hello World"
+Application Options:
+  -d, --detach  Not Attach the stdin, stdout and stderr to the process
+  -t, --tty     Allocate a pseudo-TTY
+  -m, --vm      Execute outside of any containers
+
+Help Options:
+  -h, --help    Show this help message
+```

Diff for: reference/kill.md

@@ -3,7 +3,7 @@
 Send kill signal to container or Pod
 
 	Usage:
-      hyperctl kill [OPTIONS] CONTAINER_ID|POD_ID
+      hyperctl kill [OPTIONS] CONTAINER_ID|POD_ID...
 
 	Help Options:
 	  -h, --help         Show this help message

Diff for: reference/list.md

@@ -1,11 +1,16 @@
 # list
 
-Display the Pod, VM or container information
+Display the Pod or container information
 
-	Usage:
-	  hyperctl list [OPTIONS] [pod|vm|container]
+```
+Usage:
+  hyperctl list [OPTIONS] [pod|container]
 
-	Help Options:
-	  -h, --help       Show this help message
-		-p, --pod podId  Only list the contents from specified Pod
-		-v, --vm  vmId   Only list the contents from specified VM
+list all pods or container information
+
+Application Options:
+  -p, --pod=""    only list the specified pod
+
+Help Options:
+  -h, --help      Show this help message
+```

Diff for: reference/replace.md

@@ -1,10 +1,17 @@
 # rm
 
-Remove a Pod permantly, cleanup its disk storage.
+Remove one or more pods or containers
 
+```
+Usage:
+  hyperctl rm [OPTIONS] CONTAINER|POD [CONTAINER|POD...]
 
-	Usage:
-	  hyperctl rm POD_ID [POD_ID...]
+Remove one or more containers/pods
 
-	Help Options:
-	  -h, --help  Show this help message
+Application Options:
+  -c, --container  stop container
+
+Help Options:
+  -h, --help       Show this help message
+
+```

Diff for: reference/rm.md

@@ -1,39 +1,40 @@
 # run
 
-Launch one or multiple Docker images as a Pod, with a new VM instance
-
-    Usage:
-      hyperctl run [OPTIONS] IMAGE [COMMAND] [ARG...]
-
-    Create a pod, and launch a new VM to run the pod
-
-    Application Options:
-      -p, --podfile=""       Create and Run a pod based on the pod file
-      -k, --kubernetes=""    Create and Run a pod based on the kubernetes pod file
-      -y, --yaml             Create a pod based on Yaml file
-          --name=""          Assign a name to the container
-      -a, --attach           (from podfile) Attach the stdin, stdout and stderr to the container
-      -d, --detach           (from cmdline) Not Attach the stdin, stdout and stderr to the container
-          --workdir=""       Working directory inside the container
-      -t, --tty              the run command in tty, such as bash shell
-          --cpu=1            CPU number for the VM
-          --memory=128       Memory size (MB) for the VM
-          --env=[]           Set environment variables
-          --entrypoint=""    Overwrite the default ENTRYPOINT of the image
-          --restart=""       Restart policy to apply when a container exits (never, onFailure, always)
-          --log-driver=""    Logging driver for Pod
-          --log-opt=         Log driver options
-          --rm               Automatically remove the pod when it exits
-          --publish=[]       Publish a container's port to the host, format: --publish [tcp/udp:]hostPort:containerPort
-
-    Help Options:
-      -h, --help             Show this help message
-
-	Example:
+Create a pod, and launch the new pod
+
+```
+Usage:
+  hyperctl run [OPTIONS] IMAGE [COMMAND] [ARG...]
+
+Create and start a pod
+
+Application Options:
+  -p, --podfile=""       read spec from the pod file instead of command line
+  -y, --yaml             pod file in Yaml format instead of JSON
+      --name=""          Assign a name to the container
+      --workdir=""       Working directory inside the container
+  -t, --tty              the run command in tty, such as bash shell
+      --cpu=1            CPU number for the VM (default: 1)
+      --memory=128       Memory size (MB) for the VM (default: 128)
+      --env=[]           Set environment variables
+      --entrypoint=""    Overwrite the default ENTRYPOINT of the image
+      --restart=""       Restart policy to apply when a container exits (never, onFailure, always) (default: never)
+      --log-driver=""    Logging driver for Pod
+      --log-opt=         Log driver options
+      --publish=[]       Publish a container's port to the host, format: --publish [tcp/udp:]hostPort:containerPort
+      --label=[]         Add labels for Pod, format: --label key=value
+  -v, --volume=[]        Mount host file/directory as a data file/volume, format: -v|--volume=[[hostDir:]containerDir[:options]]
+  -a, --attach           (from podfile) Attach the stdin, stdout and stderr to the container
+  -d, --detach           (from cmdline) Not Attach the stdin, stdout and stderr to the container
+      --rm               Automatically remove the pod when it exits
+
+Help Options:
+  -h, --help             Show this help message
+
+Example:
 	  hyperctl run -t ubuntu
 	  hyperctl run -t ubuntu:latest
 	  hyperctl run -t ubuntu /bin/bash
 	  hyperctl run -d nginx
 	  hyperctl run -p mypod.json
-
-
+```

Diff for: reference/run.md

@@ -1,9 +1,16 @@
 # start
 
-Launch a `Created` Pod, with a new VM instance
+Start a pod or container
 
-	Usage:
-	  hyperctl start POD_ID
+```
+Usage:
+  hyperctl start [OPTIONS] POD_ID|CONTAINER_ID
 
-	Help Options:
-	  -h, --help            Show this help message
+Launch a created pod or container
+
+Application Options:
+  -c, --container  start container
+
+Help Options:
+  -h, --help       Show this help message
+```

Diff for: reference/start.md

@@ -1,9 +1,16 @@
 # stop
 
-Stop a `Running` Pod, which will return to `Created` state
+Stop a running pod or container
 
-	Usage:
-	  hyperctl stop POD_ID
+```
+Usage:
+  hyperctl stop [OPTIONS] CONTAINER_ID|POD_ID
 
-	Help Options:
-	  -h, --help             Show this help message
+Stop running container or pod
+
+Application Options:
+  -c, --container  stop container
+
+Help Options:
+  -h, --help       Show this help message
+```