From 4f909b9208a3a16f5a825c938b446420cf85c8b0 Mon Sep 17 00:00:00 2001 From: Brendan Burns Date: Tue, 23 Dec 2014 19:57:45 -0800 Subject: [PATCH] Updates to cli docs. --- docs/cli.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index f212941b6a9..39a9546a8fb 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -6,8 +6,8 @@ The ```kubectl``` command provides command line access to the kubernetes API. #### version Print the version of the client and server. -```sh Usage: +``` kubectl version [flags] Available Flags: @@ -30,8 +30,9 @@ Use "kubectl help [command]" for more information about that command. #### proxy Create a local proxy to the API server -```sh + Usage: +``` kubectl proxy [flags] Available Flags: @@ -54,7 +55,6 @@ Usage: #### get Display one or more resources -```sh Possible resources include pods (po), replication controllers (rc), services (se), minions (mi), or events (ev). @@ -62,6 +62,7 @@ If you specify a Go template, you can use any fields defined for the API version you are connecting to the server with. Examples: +```sh $ kubectl get pods @@ -70,8 +71,9 @@ Examples: $ kubectl get -o json pod 1234-56-7890-234234-456456 - +``` Usage: +``` kubectl get [(-o|--output=)json|yaml|...] [] [flags] Available Flags: @@ -100,11 +102,11 @@ Usage: #### describe Show details of a specific resource. -```sh This command joins many API calls together to form a detailed description of a given resource. Usage: +``` kubectl describe [flags] Available Flags: @@ -136,8 +138,8 @@ Examples: $ cat pod.json | kubectl create -f - ``` -```sh Usage: +``` kubectl create -f filename [flags] Available Flags: @@ -173,8 +175,8 @@ Examples: $ cat config.json | kubectl apply -f - ``` -```sh Usage: +``` kubectl createall [-d directory] [-f filename] [flags] Available Flags: @@ -209,8 +211,8 @@ Examples: ``` -```sh Usage: +``` kubectl update -f filename [flags] Available Flags: @@ -257,8 +259,8 @@ Examples: ``` -```sh Usage: +``` kubectl delete ([-f filename] | ( [( | -l