Github user shartzel commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/1118#discussion_r48192801
--- Diff: docs/guide/ops/cli/cli-ref-guide.md ---
@@ -0,0 +1,310 @@
+---
+title: CLI Reference Guide
+layout: website-normal
+menu_parent: index.md
+children:
+- { section: List of Commands }
+- { section: Scopes }
+- { section: Abbreviations}
+- { section: Command Reference }
+- { section: Login}
+- { section: Applications}
+- { section: Entities}
+- { section: Sensors}
+- { section: Effectors}
+- { section: Policies}
+- { section: Activities}
+- { section: Miscellaneous}
+---
+
+## Usage
+{% highlight text %}
+NAME:
+ br - A Brooklyn command line client application
+
+USAGE:
+ br [global options] command [command options] [arguments...]
+{% endhighlight %}
+
+## List of Commands
+Commands whose description begins with a `*` character are particularly
experimental
+and likely to change in upcoming releases.
+
+{% highlight text %}
+COMMANDS:
+
+ 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 application from the given YAML (read from
file or stdin)
+ 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
+ policy Show the policies for an application or 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
+
+GLOBAL OPTIONS:
+ --help, -h show help
+ --version, -v print the version
+{% endhighlight %}
+
+
+## Scopes
+Many commands require a "scope" expression to indicate the target on which
they operate.
+Where this
+is required the usage statements below will use the shorthand nomenclature
of `<X-scope>`.
+The various scopes should be replaced on the command line as:
+
+- `<app-scope>`
+ `application <Name|AppID>`
+
+- `<entity-scope>`
+ `application <Name|AppID> entity <Name|EntityID>`
+
+- `<effector-scope>`
+ `application <Name|AppID> effector <Name>`
+ `application <Name|AppID> entity <Name|EntityID> effector <Name>`
+
+- `<config-scope>`
+ `application <Name|AppID> entity <Name|EntityID> config <ConfigID>`
+
+- `<activity-scope>`
+ `activity <ActivityID>`
+ `application <Name|AppID> entity <Name|EntityID> activity <ActivityID>`
+
+## Abbreviations
+Many of the commands and scopes have shortened aliases:
+
+{% highlight text %}
+activity act
+application app
+entity ent
+policy pol
+{% endhighlight %}
+
+## Command Reference
+
+### Login
+
+- `br login <URL> [username [password]]`
+ Login to Brooklyn. The CLI will prompt for a password if it is not
provided. If the Brooklyn server is running on localhost with no security
enabled, the username and password may be omitted.
+ On successful login, the version of the connected Brooklyn server is
shown.
+
+- `br version`
+ Show the version of the connected Brooklyn server.
+
+### Applications
+
+- `br deploy ( <FILE> | - )`
+ Deploy an application based on the supplied YAML file or read from STDIN
when `-` is given instead of a file name.
+
+- `br application`
+ List the running applications.
+
+- `br application <Name|AppID>`
+ Show the detail for an application.
+
+- `br <app-scope> config`
+ Show the configuration details for an application.
+
+- `br <app-scope> config <ConfigID>`
+ Show the value for a configuration item.
+
+- `br <app-scope> spec`
+ Show the YAML specification used to create the application.
+
+- `br <app-scope> rename <Name>`
+ Rename the application to <Name>.
+
+- `br <app-scope> stop`
+ Stop an application. See below for further information on the `stop`
effector.
+
+- `br <app-scope> start`
+ Start an application. See below for further information on the `start`
effector.
+
+- `br <app-scope> restart`
+ Restart an application. See below for further information on the
`restart` effector.
+
+- `br <app-scope> delete`
+ Delete an application from Brooklyn.
+ **NOTE:** Use this command with care. Even if the application /
entities are still running, Brooklyn will drop all knowledge of them and they
will be left running in an 'orphaned' state.
+
+### Entities
+
+- `br <app-scope> entity`
+ List the child entities for an application.
+
+- `br <entity-scope> entity`
+ List the child entities for an entity.
+
+- `br <app-scope> entity <Name|EntityID>`
+ Show the detail of an entity
+
+- `br <app-scope> entity -c <Name|EntityID>`
+ List the child entities for an entity.
+
+- `br <entity-scope> config`
+ Show the configuration details for an entity
--- End diff --
End line with period.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
