Metadata-Version: 2.1
Name: elasticsearch-kibana-cli
Version: 0.6.1
Summary: CLI interface to query Elasticsearch backend via the Kibana frontend.
Home-page: https://github.com/ndejong/elasticsearch_kibana_cli
Author: Nicholas de Jong
Author-email: contact@nicholasdejong.com
License: BSD2
Keywords: kibana,elasticsearch,elasticsearch-client
Platform: UNKNOWN
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.6.0,<4.0.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: bs4
Requires-Dist: maya
Requires-Dist: dpath
Requires-Dist: Flask
Requires-Dist: PyYAML
Requires-Dist: urllib3
Requires-Dist: chardet
Requires-Dist: requests
Requires-Dist: elasticsearch-dsl

# Elasticsearch Kibana CLI (eskbcli)
[![PyPi](https://img.shields.io/pypi/v/elasticsearch-kibana-cli.svg)](https://pypi.python.org/pypi/elasticsearch-kibana-cli/)
[![Python Versions](https://img.shields.io/pypi/pyversions/elasticsearch-kibana-cli.svg)](https://github.com/ndejong/elasticsearch_kibana_cli/)
[![Build Status](https://github.com/ndejong/elasticsearch_kibana_cli/actions/workflows/build-tests.yml/badge.svg)](https://github.com/ndejong/elasticsearch_kibana_cli/actions/workflows/build-tests.yml)
[![Read the Docs](https://img.shields.io/readthedocs/elasticsearch-kibana-cli)](https://elasticsearch-kibana-cli.readthedocs.io)
![License](https://img.shields.io/github/license/ndejong/elasticsearch_kibana_cli.svg)

ElasticSearch Kibana CLI (`eskbcli`) provides a shell interface to query
an ElasticSearch backend via the Kibana frontend which is useful in
situations where the ElasticSearch backend is not otherwise accessible.

ElasticSearch Kibana CLI makes it possible to copy-paste query expressions
directly from the Kibana user-interface and then easily access very large
sets of result data.  This makes the `eskbcli` useful in SecOps situations
where the ability to rapidly move from a Kibana query to raw data is
valued.

Configuration options are available to adjust http-headers so-as-to enable
access to Kibana in situations that require complex user-authentication
such as when Kibana exists behind an OAuth reverse proxy or other session-
based authentication arrangement.

## Install / Upgrade
```shell
user@computer:~$ pip install [--upgrade] elasticsearch-kibana-cli
```


## Documentation
Documentation is available at https://elasticsearch-kibana-cli.readthedocs.io

### Usage
* [search](docs/usage/search) - Execute the named search configuration.
* [summary](docs/usage/summary) - Summary report for search result datafile; use "-" to pipe stdin.
* [show](docs/usage/show) - Show the named eskbcli search configuration.
* [list](docs/usage/list) - List the available eskbcli search names.

### Config files
Refer to the worked example [config files](https://elasticsearch-kibana-cli.readthedocs.io/en/latest/docs/config-file/) 
with descriptions and details.

## Project
* Github - [github.com/ndejong/elasticsearch_kibana_cli](https://github.com/ndejong/elasticsearch_kibana_cli)
* PyPI - [pypi.python.org/pypi/elasticsearch-kibana-cli](https://pypi.python.org/pypi/elasticsearch-kibana-cli/)
* ReadTheDocs - [elasticsearch-kibana-cli.readthedocs.io](https://elasticsearch-kibana-cli.readthedocs.io)

---
Copyright &copy; 2021 Nicholas de Jong


