You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,10 +34,20 @@ Quick Start
34
34
35
35
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/).
36
36
37
+
**Shorthand Command:** You can use `osb` as a shorthand for `opensearch-benchmark`:
* Quick help: ``opensearch-benchmark --help`` or ``osb --help``
41
51
* 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
42
52
* 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).
43
53
* File improvements or bug reports in our [Github repo](<https://github.com/opensearch-project/OpenSearch-Benchmark/issues>).
Copy file name to clipboardExpand all lines: RELEASE_GUIDE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,7 +72,7 @@ Add backport labels to PRs and commits so that changes can be added to `main` br
72
72
2. Install it with `pip install`.
73
73
3. Run `opensearch-benchmark --version` to ensure that it is the correct version
74
74
4. Run `opensearch-benchmark --help`
75
-
5. Run `opensearch-benchmark list workloads`
75
+
5. Run `opensearch-benchmark list workloads` (or `osb list workloads`)
76
76
6. Run a basic workload on Linux and MacOS: `opensearch-benchmark run --workload pmc --test-mode`
77
77
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.
0 commit comments