diff --git a/plugins/elasticsearch/README.md b/plugins/elasticsearch/README.md new file mode 100644 index 000000000..2fae0a68c --- /dev/null +++ b/plugins/elasticsearch/README.md @@ -0,0 +1,18 @@ +elasticsearch +======= +This plugin makes easy to use Elasticsearch API and it also offering autocomplete for common APIs. +There are `GET`, `HEAD`, `DELETE`, `PUT` and `POST` commands. + +Examples usage: +- `GET _cluster/health` +- `GET _cat` +- `DELETE twitter` + + +Aliases +------- + +- `alias ech='GET _cluster/health'`: Cluster status health +- `alias ecs='GET _cluster/state'`: Allows to get a comprehensive state information of the whole cluster +- `alias ens='GET _nodes/stats'`: Allows to retrieve all of the cluster nodes statistics +- `alias esf='GET _stats/fielddata'`: Field data memory usage on index level diff --git a/plugins/elasticsearch/_GET b/plugins/elasticsearch/_GET index 7fe4842d9..aad95d43e 100644 --- a/plugins/elasticsearch/_GET +++ b/plugins/elasticsearch/_GET @@ -3,6 +3,7 @@ local -a options options=( '_cache/clear:Allows to clear all caches for all indices' + '_cat:List of all cat commands' '_cluster/health:Cluster status health' '_cluster/nodes/_local/_shutdown:Shutdown local node' '_cluster/pending_tasks:Returns a list of any cluster-level changes which have not yet been executed'