Skip to content

Commit

Permalink
Cleanup CLI for 1.5 Fixes elastic#3280
Browse files Browse the repository at this point in the history
  • Loading branch information
suyograo authored and jordansissel committed May 27, 2015
1 parent 827fc6d commit f8a7c27
Showing 1 changed file with 28 additions and 14 deletions.
42 changes: 28 additions & 14 deletions docs/asciidoc/static/command-line-flags.asciidoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
== Command-line flags

[float]
=== Agent
=== Pipeline

The Logstash agent has the following flags. (You can use the '--help' flag to
The Logstash pipeline has the following flags. (You can use the `--help` flag to
display this information.)

[source,js]
[source,shell]
----------------------------------
-f, --config CONFIGFILE
Load the Logstash config from a specific file, directory, or a wildcard. If
Expand Down Expand Up @@ -36,19 +36,33 @@ display this information.)
-v
*DEPRECATED: see --verbose/debug* Increase verbosity. There are multiple levels
of verbosity available with '-vv' currently being the highest
--pluginpath PLUGIN_PATH
A colon-delimited path to find other Logstash plugins in
----------------------------------

[float]
=== Web
=== Plugins

[source,js]
----------------------------------
-a, --address ADDRESS
Address on which to start webserver. Default is 0.0.0.0.
`$LS_HOME/bin/plugin` script will be used for all plugin lifecycle interaction

-p, --port PORT
Port on which to start webserver. Default is 9292.
----------------------------------
### Installing a plugin
`bin/plugin install logstash-output-kafka`

Alternatively, using a file location:
`bin/plugin install /path/to/logstash-output-kafka-1.0.0.gem`

### Removing a plugin

`bin/plugin uninstall logstash-output-kafka`

### Updating one or all plugins

`bin/plugin update` will update all installed plugins

`bin/plugin update logstash-output-kafka` will update only this plugin

### Listing plugins

`bin/plugin list`

`bin/plugin list elasticsearch` Will list all plugins containing a name

`bin/plugin list --group output` Will list plugins for a particular group

0 comments on commit f8a7c27

Please sign in to comment.