logstash/docs/static/plugin-generator.asciidoc
2016-07-01 14:11:08 -04:00

19 lines
808 B
Text

[[plugin-generator]]
=== Generating Plugins
You can now create your own Logstash plugin in seconds! The generate subcommand of `bin/logstash-plugin` creates the foundation
for a new Logstash plugin with templatized files. It creates the correct directory structure, gemspec files, and dependencies so you
can start adding custom code to process data with Logstash.
**Example Usage**
[source,sh]
--------------------------------------------
bin/logstash-plugin generate --type input --name xkcd --path ~/ws/elastic/plugins
-------------------------------------------
* `--type`: Type of plugin - input, filter, output, or codec
* `--name`: Name for the new plugin
* `--path`: Directory path where the new plugin structure will be created. If not specified, it will be
created in the current directory.