You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2016/02/01 18:28:37 UTC
[03/50] brooklyn-docs git commit: Add documentation for brooklyn cli
Add documentation for brooklyn cli
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/f2dab8de
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/f2dab8de
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/f2dab8de
Branch: refs/heads/0.4.0
Commit: f2dab8de5e18f14636833ac7c22ad8ca8508888b
Parents: 8be715a
Author: Cosmin Dumitrache <co...@cloudsoftcorp.com>
Authored: Wed May 30 16:37:28 2012 +0100
Committer: Cosmin Dumitrache <co...@cloudsoftcorp.com>
Committed: Wed May 30 16:37:28 2012 +0100
----------------------------------------------------------------------
docs/use/guide/management/index.md | 44 +++++++++++++++++++++++++++++++++
docs/use/guide/management/toc.json | 4 ++-
2 files changed, 47 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f2dab8de/docs/use/guide/management/index.md
----------------------------------------------------------------------
diff --git a/docs/use/guide/management/index.md b/docs/use/guide/management/index.md
index 225d702..f010836 100644
--- a/docs/use/guide/management/index.md
+++ b/docs/use/guide/management/index.md
@@ -49,6 +49,50 @@ although in those contexts the conventional format ``BROOKLYN_JCLOUDS_AWS_EC2_ID
is supported and recommended.
+
+<a name="cli"></a>
+Command Line Interface
+----------------------
+
+Brooklyn comes with a Command Line Interface (cli) that makes it easier to launch an application.
+
+In order to have easy access to the cli it is useful to configure the PATH environment variable to also point to the cli's bin directory:
+
+{% highlight bash %}
+% BROOKLYN_HOME=/path/to/brooklyn/
+% export PATH=$PATH:$BROOKLYN_HOME/usage/dist/target/brooklyn-0.4..0-SNAPSHOT-dist/brooklyn/bin
+{% endhighlight %}
+
+If you have set this up correctly you should be able to invoke the ```brooklyn``` command:
+
+{% highlight bash %}
+% brooklyn
+{% endhighlight %}
+
+To get information about all the supported cli options just run:
+
+{% highlight bash %}
+% brooklyn help
+usage: brooklyn [(-q | --quiet)] [(-v | --verbose)] <command> [<args>]
+
+The most commonly used brooklyn commands are:
+ help Display help information about brooklyn
+ launch Starts a brooklyn application. Note that a BROOKLYN_CLASSPATH environment variable needs to be set up beforehand to point to the user application classpath.
+
+See 'brooklyn help <command>' for more information on a specific command.
+{% endhighlight %}
+
+Here is an example of the commands you might run to launch a Brooklyn application:
+
+{% highlight bash %}
+% BROOKLYN_HOME=/path/to/brooklyn
+% PATH=$PATH:${BROOKLYN_HOME}/usage/dist/target/brooklyn-0.4.0-SNAPSHOT-dist/brooklyn/bin
+% export BROOKLYN_CLASSPATH=${BROOKLYN_HOME}/examples/simple-web-cluster/target/brooklyn-example-simple-web-cluster-0.4.0-SNAPSHOT.jar
+% brooklyn launch --app brooklyn.demo.SingleWebServerExample --location localhost
+{% endhighlight %}
+
+
+
<a name="console"></a>
Management Web Console
----------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f2dab8de/docs/use/guide/management/toc.json
----------------------------------------------------------------------
diff --git a/docs/use/guide/management/toc.json b/docs/use/guide/management/toc.json
index f6468ff..f470c2d 100644
--- a/docs/use/guide/management/toc.json
+++ b/docs/use/guide/management/toc.json
@@ -1,7 +1,9 @@
[{ "title": "Introduction",
"file": "{{ site.url }}/use/guide/management/index.html#introduction" },
{ "title": "Startup Configuration",
- "file": "{{ site.url }}/use/guide/management/index.html#startup-config" },
+ "file": "{{ site.url }}/use/guide/management/index.html#startup-config" },
+{ "title": "Command Line Interface",
+ "file": "{{ site.url }}/use/guide/management/index.html#cli" },
{ "title": "Management Web Console",
"file": "{{ site.url }}/use/guide/management/index.html#console" },
{ "title": "Observation APIs",