simplify the README bundled with the binaries
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-client/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-client/commit/553ad8b3 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-client/tree/553ad8b3 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-client/diff/553ad8b3 Branch: refs/heads/master Commit: 553ad8b301e9213713d255c43c90558374c41f2d Parents: 284627a Author: Alex Heneveld <alex.henev...@cloudsoftcorp.com> Authored: Thu Mar 10 10:55:56 2016 +0000 Committer: Alex Heneveld <alex.henev...@cloudsoftcorp.com> Committed: Thu Mar 10 10:55:56 2016 +0000 ---------------------------------------------------------------------- README | 118 +++++++++--------------------------------------------------- 1 file changed, 16 insertions(+), 102 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-client/blob/553ad8b3/README ---------------------------------------------------------------------- diff --git a/README b/README index 6041f91..da1f0a0 100644 --- a/README +++ b/README @@ -1,55 +1,34 @@ - Apache Brooklyn Command Line Client +Apache Brooklyn Command Line Client +=================================== What is it? ----------- -A command line client, "br", for Apache Brooklyn (https://brooklyn.apache.org). +A command line client, "br", for **[Apache Brooklyn](https://brooklyn.apache.org)**. With this tool you can deploy and manage applications on a running Brooklyn server. -Documentation -------------- +This file gives a brief summary of how to use the Brooklyn CLI client tool. +More complete documentation is available **[on the Apache Brooklyn website](https://brooklyn.apache.org/v/latest/ops/cli/cli-ref-guide.html). -There follows below a brief summary of how to use the tool, however, the full documentation for the tool is included -along with the [Brooklyn Documentation](https://brooklyn.apache.org/v/latest/ops/cli/cli-ref-guide.html). -Licensing ---------- - -Please see the file called LICENSE. - -Getting the right binary ------------------------- - -The release for the tool includes binaries built for a number of platforms and architectures. These binaries are -provided in subdirectories alongside this README, named for the platform and architecture: +License +------- -darwin.386/br -darwin.amd64/br -freebsd.386/br -freebsd.amd64/br -linux.386/br -linux.amd64/br -netbsd.386/br -netbsd.amd64/br -openbsd.386/br -openbsd.amd64/br -windows.386/br -windows.amd64/br +Please see the file [LICENSE](LICENSE). -To use the tool, add the appropriate subdirectory to your PATH, for example, when br is obtained by extracting the -main Apache Brooklyn release into your home directory under "apache-brooklyn", then the command would be like -$ PATH=$PATH:$HOME/apache-brooklyn/bin/brooklyn-client-cli-0.9.0/linux.amd64 +Getting Started +--------------- +Find the binary which is right for your platform. +You'll typically find it in a sub-directory here. +(Note that "Darwin" is a technical name for "Mac OS X".) -Running -------- +Add it to your path or alias it with `br`. -Ensure your path contains $GOPATH/bin. - -First, log in to your Brooklyn instance with: +Then log in to your Brooklyn instance with: $ br login URL [USER PASSWORD] @@ -57,72 +36,7 @@ See the help command for info on all commands: $ br help -And for help on individual commands: +For help on individual commands: $ br help COMMAND - -Scopes ------- - -Many commands require a "scope" expression to indicate the target on which they operate. The scope expressions are -as follows (values in brackets are aliases for the scope): - -- application APP-ID (app, a) - Selects an application, e.g. "br app myapp" - -- entity ENT-ID (ent, e) - Selects an entity within an application scope, e.g. "br app myapp ent myserver" - -- effector EFF-ID (eff, f) - Selects an effector of an entity or application, e.g. "br a myapp e myserver eff xyz" - -- config CONF-KEY (conf, con, c) - Selects a configuration key of an entity e.g. "br a myapp e myserver config jmx.agent.mode" - -- activity ACT-ID (act, v) - Selects an activity of an entity e.g. "br a myapp e myserver act iHG7sq1" - - -Commands --------- - -Commands whose description begins with a "*" character are particularly experimental and likely to change in upcoming -releases. If not otherwise specified, "SCOPE" below means application or entity scope. If an entity scope is not -specified, the application entity is used as a default. - -- access Show access control -- activity Show the activity for an application / entity -- add-catalog * Add a new catalog item from the supplied YAML -- add-children * Add a child or children to this entity from the supplied YAML -- application Show the status and location of running applications -- catalog * List the available catalog applications -- config Show the config for an application or entity -- delete * Delete (expunge) a brooklyn application -- deploy Deploy a new brooklyn application from the supplied YAML -- destroy-policy * Destroy a policy -- effector Show the effectors for an application or entity -- entity Show the entities of an application or entity -- env Show the ENV stream for a given activity -- invoke Invoke an effector of an application and entity -- locations * List the available locations -- login Login to brooklyn -- policies Show the list of policies for an application and entity -- policy Show the status of a policy for an application and entity -- rename Rename an application or entity -- restart Invoke restart effector on an application and entity -- sensor Show values of all sensors or named sensor for an application or entity -- set Set config for an entity -- spec Get the YAML spec used to create the entity, if available -- start Invoke start effector on an application and entity -- start-policy Start or resume a policy -- stderr Show the STDERR stream for a given activity -- stdin Show the STDIN stream for a given activity -- stdout Show the STDOUT stream for a given activity -- stop Invoke stop effector on an application and entity -- stop-policy Suspends a policy -- tree * Show the tree of all applications -- version Display the version of the connected Brooklyn -- help - -
