- [OpenSearch Reporting CLI](#opensearch-reporting-cli) - [Setup](#setup) - [Examples](#examples) - [Contributing](#contributing) - [Code of Conduct](#code-of-conduct) - [Security](#security) - [License](#license) - [Copyright](#copyright) # OpenSearch Reporting CLI OpenSearch Reporting CLI is a quick out-of-box options to be able to download reports without using Dashboards. ## Setup To download and install the Reporting CLI from npm, run the following command. ```bash npm i @opensearch-project/reporting-cli ``` You can also download the `opensearch-reporting-cli` tool from the [OpenSearch.org](https://opensearch.org/downloads.html) and run the following command. ```bash npm install -g opensearch-reporting-cli-1.0.0.tgz ``` ## Examples Please see the [USER_GUIDE](USER_GUIDE.md) for examples. ## Contributing We welcome you to get involved in development, documentation, testing the OpenSearch Dashboards reports plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in. ## Code of Conduct This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. ## Security If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. ## License See the [LICENSE](./LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. ## Copyright Copyright OpenSearch Contributors. See [NOTICE](NOTICE) for details.