Naarcha-AWS 2a5864ed6b
Add editorial for both Benchmark sections (#4192)
* Benchmark editorial

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-26 22:52:01 -05:00

27 lines
1.0 KiB
Markdown

---
layout: default
title: Command reference
nav_order: 50
has_children: true
---
# OpenSearch Benchmark command reference
This section provides a list of commands supported by OpenSearch Benchmark, including commonly used commands such as `execute-test` and `list`.
- [compare]({{site.url}}{{site.baseurl}}/benchmark/commands/compare/)
- [download]({{site.url}}{{site.baseurl}}/benchmark/commands/download/)
- [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/)
- [generate]({{site.url}}{{site.baseurl}}/benchmark/commands/generate/)
- [info]({{site.url}}{{site.baseurl}}/benchmark/commands/info/)
- [list]({{site.url}}{{site.baseurl}}/benchmark/commands/list/)
## List of common options
All OpenSearch Benchmark commands support the following options:
- `--h` or `--help`: Provides options and other useful information about each command.
- `--quiet`: Hides as much of the results output as possible. Default is `false`.
- `--offline`: Indicates whether OpenSearch Benchmark has a connection to the internet. Default is `false`.