Skip to content

Commit 3dbfac8

Browse files
author
Pepper Pancoast
committed
Document osb shorthand command
Addresses #744 Add documentation for the 'osb' shorthand command that can be used as an alias for 'opensearch-benchmark', making it easier and faster to invoke the tool.
1 parent 94f93db commit 3dbfac8

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,20 @@ Quick Start
3434

3535
Want to get started with OpenSearch Benchmark quickly? See [OpenSearch Benchmark's Quick Start guide in the documentation](https://opensearch.org/docs/latest/benchmark/index/).
3636

37+
**Shorthand Command:** You can use `osb` as a shorthand for `opensearch-benchmark`:
38+
39+
```bash
40+
# Full command
41+
opensearch-benchmark execute-test --workload=geonames
42+
43+
# Shorthand equivalent
44+
osb execute-test --workload=geonames
45+
```
46+
3747
Getting help
3848
------------
3949

40-
* Quick help: ``opensearch-benchmark --help``
50+
* Quick help: ``opensearch-benchmark --help`` or ``osb --help``
4151
* Want to contribute? Look at [OpenSearch Benchmark's Developer Guide](<https://github.com/opensearch-project/OpenSearch-Benchmark/blob/main/DEVELOPER_GUIDE.md>) for more information
4252
* For any questions or answers, visit our [community forum](<https://discuss.opendistrocommunity.dev/>) and Slack community channel [#performance-benchmarking](https://opensearch.slack.com/archives/C082PLA3VPW).
4353
* File improvements or bug reports in our [Github repo](<https://github.com/opensearch-project/OpenSearch-Benchmark/issues>).

RELEASE_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Add backport labels to PRs and commits so that changes can be added to `main` br
7272
2. Install it with `pip install`.
7373
3. Run `opensearch-benchmark --version` to ensure that it is the correct version
7474
4. Run `opensearch-benchmark --help`
75-
5. Run `opensearch-benchmark list workloads`
75+
5. Run `opensearch-benchmark list workloads` (or `osb list workloads`)
7676
6. Run a basic workload on Linux and MacOS: `opensearch-benchmark run --workload pmc --test-mode`
7777
7. If you are fastidious, you can check the installed source files at `` `python3 -m site --user-site`/osbenchmark `` to verify that a recent change is indeed present.
7878

0 commit comments

Comments
 (0)