Merge pull request #9 from laijs/rename

carmark · carmark · commit bb8a5a13e973 · 2016-04-12T13:59:38.000+08:00
rename hyper to hyperctl
diff --git a/get_started/install/build.md b/get_started/install/build.md
@@ -20,7 +20,7 @@ And make sure you have `go` (>= 1.4) and `autotools`, develop files of
 
 (If you want to build without Xen support, use configure option `--without-xen`.)
 
-Then you can get the binaries `hyperd` daemon and `hyper` CLI tool.
+Then you can get the binaries `hyperd` daemon and `hyperctl` CLI tool.
 
 #### Build Xen from source
 
diff --git a/get_started/install/mac.md b/get_started/install/mac.md
@@ -14,7 +14,7 @@ To install Hyper on Mac OS X, you need first to install VirtualBox 5.0, then dow
 The Hyper Mac package contains
 
 - `hyperd` Daemon, which could be controled with `launchctl`
-- `hyper` cli tool with
+- `hyperctl` command line control tool with
 - An uninstall shell script, located under `/opt/hyper/bin/uninstall-hyper.sh`
 
 > If you need to uninstall hyper and clean all existing images and containers, call the uninstall script with `--purge` flag.
diff --git a/get_started/lifecycle.md b/get_started/lifecycle.md
@@ -10,38 +10,38 @@ In Hyper, a Pod has two states:
 
 A Pod can be launched either explicitly:
 
-	[root@user ~:]# hyper run -p podfile.json
+	[root@user ~:]# hyperctl run -p podfile.json
 
 Or, implicitly:
 
-	[root@user ~:]# hyper run -t ubuntu
+	[root@user ~:]# hyperctl run -t ubuntu
 
 In both cases, Pods and VMs are indivisible. Hyper will automatically provision a new VM instance to host the Pod, and the Pod will be `Running`.
 
 However, you can also create a Pod, but without an underlying VM. In such case, the pod stays in `Created` state.
 
-    [root@user ~:]# hyper create -p podfile.json
+    [root@user ~:]# hyperctl create -p podfile.json
 
 There are two options to start the pod:
 
-    [root@user ~:]# hyper start pod_id
+    [root@user ~:]# hyperctl start pod_id
 
 The `START` command will trigger a VM provisioned, and allocate the new VM to the Pod. Alternatively, you can choose to `REPLACE` a running one:
 
-    [root@user ~:]# hyper replace -o old_pod_id -n new_pod_id
+    [root@user ~:]# hyperctl replace -o old_pod_id -n new_pod_id
 
 In this case, the VM instance will be de-associated from `old_pod_id` and re-assign to `new_pod_id`. Since the VM is already present, `REPLACE` is a faster option to launch a pod, than `RUN` and `START`.
 
 > Note: `old_pod_id` must be running.
 
 When you `STOP` a Pod, the underlying VM instance will be terminated:
 
-    [root@user ~:]# hyper stop pod_id
+    [root@user ~:]# hyperctl stop pod_id
 
 When stopped, the Pod will return to the `Created` state.
 
 To permantly destroy a Pod, you need to `RM` it:
 
-    [root@user ~:]# hyper rm pod_id
+    [root@user ~:]# hyperctl rm pod_id
 
 Hyper will (stop if neccessary, then) remove the Pod definition and its storage.
diff --git a/how_it_works.md b/how_it_works.md
@@ -2,21 +2,21 @@
 
 Hyper has four components:
 
-  - CLI: ***hyper***
+  - CLI: ***hyperctl***
   - Daemon: ***hyperd*** (with REST APIs)
   - Guest Kernel: ***hyperkernel***
   - Guest Init Service: ***hyperstart***
 
 On a physical Linux host:
 
-        [root@user ~:]# hyper pull nginx:latest
-        [root@user ~:]# hyper run nginx:latest
+        [root@user ~:]# hyperctl pull nginx:latest
+        [root@user ~:]# hyperctl run nginx:latest
 
 Upon ***RUN***, Hyper launches the Docker images with a new VM instance, instead of Linux containers:
 
         [root@user ~:]# docker ps
         [root@user ~:]#
-        [root@user ~:]# hyper list
+        [root@user ~:]# hyperctl list
         ......
         Done
 
diff --git a/pod/README.md b/pod/README.md
@@ -12,7 +12,7 @@ The key idea behind **Pod** is that in a microservice architecture usually invol
 
 In Hyper, a pod consists of a colocated group of AppContainer images, deployed as a single unit in one Hyper instance.
 
-	[root@user ~:]# hyper run -p nginx rails logstash cronjob
+	[root@user ~:]# hyperctl run -p nginx rails logstash cronjob
 
 Inside of the instance, multiple applications from different images share the namespaces: ***`PID`***, ***`Network`***, ***`IPC`***, ***`UTS`***, ***`User`***. Pod helps to provide a familiar view of a tranditional OS to applications, rather than the philosophy of "*one process per container*":
 
diff --git a/reference/attach.md b/reference/attach.md
@@ -3,7 +3,7 @@
 Attach a specified container in a Pod to TTY
 
 	Usage:
-	  hyper attach CONTAINER
+	  hyperctl attach CONTAINER
 
 	Help Options:
 	  -h, --help  Show this help message
diff --git a/reference/build.md b/reference/build.md
@@ -4,7 +4,7 @@ Build a new image from the source code at PATH
 
 ```
 Usage:
-	hyper build [OPTIONS] PATH
+	hyperctl build [OPTIONS] PATH
 
 Application Options:
 	-t, --tag=""     Repository name (and optionally a tag) to be applied to the resulting image in case of success
@@ -14,5 +14,5 @@ Help Options:
 	-h, --help       Show this help message
 
 Example:
-	hyper build -t test /dockerfile/path/
+	hyperctl build -t test /dockerfile/path/
 ```
diff --git a/reference/cli.md b/reference/cli.md
@@ -3,7 +3,7 @@
 ```
 Usage:
 
-	hyper [OPTIONS] COMMAND [ARGS...]
+	hyperctl [OPTIONS] COMMAND [ARGS...]
 
 Command:
 
@@ -30,5 +30,5 @@ Help Options:
 
     -h, --help             Show this help message
 
-Run 'hyper COMMAND --help' for more information on a command.
+Run 'hyperctl COMMAND --help' for more information on a command.
 ```
diff --git a/reference/commit.md b/reference/commit.md
@@ -6,7 +6,7 @@ Create a new image from a container's changes
 
 ```
 Usage:
-	hyper commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
+	hyperctl commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
 
 Application Options:
 	-a, --author=""     Author (e.g., "Hello World <hello@a-team.com>")
diff --git a/reference/containers.md b/reference/containers.md
@@ -2,7 +2,7 @@
 
 - `name`: the identifier of a container; a random id will be given if absent
 
-- `image`: in the form `[registry]/image[:tag]`; hyper will automatically pull the image if missing
+- `image`: in the form `[registry]/image[:tag]`; hyperctl will automatically pull the image if missing
 
 - `command`: the shell command to run when the container starts
 
diff --git a/reference/create.md b/reference/create.md
@@ -3,7 +3,7 @@
 Define a Pod and allocate storage, but without starting it. The Pod will stay in `Created` state.
 
 	Usage:
-	  hyper create POD_FILE
+	  hyperctl create POD_FILE
 
 	Help Options:
 	  -h, --help  Show this help message
diff --git a/reference/exec.md b/reference/exec.md
@@ -3,10 +3,10 @@
 Run a command in a container or a Pod, and attach the current terminal to the command stdio.
 
 	Usage:
-	  hyper exec POD_ID:CONTAINER_NAME COMMAND [ARGS...]
+	  hyperctl exec POD_ID:CONTAINER_NAME COMMAND [ARGS...]
 
 	Help Options:
 	  -h, --help            Show this help message
 
     Example:
-      hyper exec pod-3uhg23po:nginx echo "Hello World"
+      hyperctl exec pod-3uhg23po:nginx echo "Hello World"
diff --git a/reference/images.md b/reference/images.md
@@ -4,7 +4,7 @@ List images
 
 ```
 Usage:
-	hyper images [OPTIONS] [REPOSITORY]
+	hyperctl images [OPTIONS] [REPOSITORY]
 
 Application Options:
 	-a, --all            Show all images (by default filter out the intermediate image layers) (false)
diff --git a/reference/info.md b/reference/info.md
@@ -3,7 +3,7 @@
 Display system-wide information
 
 	Usage:
-	  hyper info
+	  hyperctl info
 
 	Help Options:
 	  -h, --help  Show this help message
diff --git a/reference/kill.md b/reference/kill.md
@@ -3,7 +3,7 @@
 Kill an idle running VM
 
 	Usage:
-	  hyper kill VM_ID
+	  hyperctl kill VM_ID
 
 	Help Options:
 	  -h, --help  Show this help message
diff --git a/reference/list.md b/reference/list.md
@@ -3,7 +3,7 @@
 Display the Pod, VM or container information
 
 	Usage:
-	  hyper list [OPTIONS] [pod|vm|container]
+	  hyperctl list [OPTIONS] [pod|vm|container]
 
 	Help Options:
 	  -h, --help       Show this help message
diff --git a/reference/login.md b/reference/login.md
@@ -5,7 +5,7 @@ specified "https://index.docker.io/v1/" is the default.
 
 ```
 Usage:
-  hyper login [SERVER]
+  hyperctl login [SERVER]
 
 Application Options:
   -e, --email=""       Email
diff --git a/reference/logout.md b/reference/logout.md
@@ -4,7 +4,7 @@ Log out from a Docker registry, if no server is specified "https://index.docker.
 
 ```
 Usage:
-	hyper logout [SERVER]
+	hyperctl logout [SERVER]
 
 Help Options:
 	-h, --help  Show this help message
diff --git a/reference/pull.md b/reference/pull.md
@@ -4,7 +4,7 @@ Pull an image from a Docker registry server
 
 ```
 Usage:
-	hyper pull IMAGE
+	hyperctl pull IMAGE
 
 Help Options:
 	-h, --help  Show this help message
diff --git a/reference/push.md b/reference/push.md
@@ -4,7 +4,7 @@ Push an image to a Docker registry server
 
 ```
 Usage:
-	hyper push NAME[:TAG]
+	hyperctl push NAME[:TAG]
 
 Help Options:
 	-h, --help  Show this help message
diff --git a/reference/replace.md b/reference/replace.md
@@ -5,7 +5,7 @@ Deallocate the VM instance from a `Running` Pod A and re-assign to a `Created` P
 (This command is only avaiable on Linux version)
 
 	Usage:
-	  hyper replace --oldpod POD_ID --newpod POD_ID [--file POD_FILE]
+	  hyperctl replace --oldpod POD_ID --newpod POD_ID [--file POD_FILE]
 
 	Application Options:
 	  -o, --oldpod=""    The Pod that will be replaced, must be in 'running' status
diff --git a/reference/rm.md b/reference/rm.md
@@ -4,7 +4,7 @@ Remove a Pod permantly, cleanup its disk storage.
 
 
 	Usage:
-	  hyper rm POD_ID [POD_ID...]
+	  hyperctl rm POD_ID [POD_ID...]
 
 	Help Options:
 	  -h, --help  Show this help message
diff --git a/reference/rmi.md b/reference/rmi.md
@@ -4,7 +4,7 @@ Remove one or more images
 
 ```
 Usage:
-	hyper rmi [OPTIONS] IMAGE [IMAGE...]
+	hyperctl rmi [OPTIONS] IMAGE [IMAGE...]
 
 Application Options:
 	    --no-prune  Do not delete untagged parents
diff --git a/reference/run.md b/reference/run.md
@@ -3,7 +3,7 @@
 Launch one or multiple Docker images as a Pod, with a new VM instance
 
     Usage:
-      hyper run [OPTIONS] IMAGE [COMMAND] [ARG...]
+      hyperctl run [OPTIONS] IMAGE [COMMAND] [ARG...]
 
     Create a pod, and launch a new VM to run the pod
 
@@ -30,10 +30,10 @@ Launch one or multiple Docker images as a Pod, with a new VM instance
       -h, --help             Show this help message
 
 	Example:
-	  hyper run -t ubuntu
-	  hyper run -t ubuntu:latest
-	  hyper run -t ubuntu /bin/bash
-	  hyper run -d nginx
-	  hyper run -p mypod.json
+	  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 --git a/reference/start.md b/reference/start.md
@@ -3,7 +3,7 @@
 Launch a `Created` Pod, with a new VM instance
 
 	Usage:
-	  hyper start POD_ID
+	  hyperctl start POD_ID
 
 	Help Options:
 	  -h, --help            Show this help message
diff --git a/reference/stop.md b/reference/stop.md
@@ -3,7 +3,7 @@
 Stop a `Running` Pod, which will return to `Created` state
 
 	Usage:
-	  hyper stop POD_ID
+	  hyperctl stop POD_ID
 
 	Help Options:
 	  -h, --help             Show this help message
