Skip to content

Commit

Permalink
Added a README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Cosmin Dumitrache committed May 16, 2012
1 parent 97fcd83 commit e990aa1
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions usage/cli/README.md
@@ -0,0 +1,71 @@
Brooklyn CLI
============

This is the Command Line Interface that you can use to interact with Brooklyn.

Commands available
==================

```
$ brooklyn help
usage: brooklyn [(-v | --verbose)] [(-q | --quiet)] <command> [<args>]
The most commonly used brooklyn commands are:
help Display help information
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.
```

Launch command options
======================

```
$ brooklyn help launch
NAME
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.
SYNOPSIS
brooklyn [(-q | --quiet)] [(-v | --verbose)] launch
[(-s <script URI> | --script <script URI>)] [(-nc | --noConsole)] [(-l <location list> | --location <location list> | --locations <location list>)...]
(-a <application class or file> | --app <application class or file>)
[(-p <port number> | --port <port number>)]
OPTIONS
-a <application class or file>, --app <application class or file>
The Application to start. For example my.AppName or
file://my/AppName.groovy or classpath://my/AppName.groovy
-l <location list>, --location <location list>, --locations <location
list>
Specifies the locations where the application will be launched.
-nc, --noConsole
Whether to start the web console
-p <port number>, --port <port number>
Specifies the port to be used by the Brooklyn Management Console.
-q, --quiet
Quiet mode
-s <script URI>, --script <script URI>
EXPERIMENTAL. URI for a Groovy script to parse and load. This script
will run before starting the app.
-v, --verbose
Verbose mode
```

Example usage
=============

Launching one of the examples on localhost:
```
$ BROOKLYN_HOME=/path/to/brooklyn
$ PATH=$PATH:${BROOKLYN_HOME}/usage/dist/brooklyn-0.4.0-SNAPSHOT-dist/bin
$ export BROOKLYN_CLASSPATH=${BROOKLYN_HOME}/examples/simple-web-cluster/target/classes/ # point this to your app
$ brooklyn launch --app brooklyn.demo.SingleWebServerExample # --location is set to localhost by default
```

0 comments on commit e990aa1

Please sign in to comment.