inferbench-cli 0.1.0__tar.gz

inferbench_cli-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+.venv-freshinstall/
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.pyc
+.pytest_cache/

inferbench_cli-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

inferbench_cli-0.1.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: inferbench-cli
+Version: 0.1.0
+Summary: Vendor-neutral local-LLM-inference benchmark and hardware-config advisor for omlx and llama.cpp -- measures real tokens/second on your own hardware, live.
+Project-URL: Homepage, https://github.com/RudrenduPaul/InferBench
+Project-URL: Repository, https://github.com/RudrenduPaul/InferBench
+Project-URL: Bug Tracker, https://github.com/RudrenduPaul/InferBench/issues
+Project-URL: Changelog, https://github.com/RudrenduPaul/InferBench/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/RudrenduPaul/InferBench/blob/main/docs/getting-started.md
+Project-URL: Author - Rudrendu Paul, https://github.com/RudrenduPaul
+Project-URL: Author - Sourav Nandy, https://github.com/Sourav-nandy-ai
+Author: Rudrendu Paul, Sourav Nandy
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: apple-silicon,benchmark,cli,inference,llama.cpp,llm,local-llm,mlx,omlx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Benchmark
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.0; extra == 'dev'
+Requires-Dist: pytest<10,>=7.0; extra == 'dev'
+Requires-Dist: twine<7,>=5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# inferbench-cli (Python)
+
+Vendor-neutral benchmark for local-LLM-inference engines -- measures real
+tokens/second for `omlx` and `llama.cpp` on your own hardware, live, and
+recommends the faster engine for your exact machine and model. This
+package is the Python distribution -- a genuine, independent port of the
+npm package's TypeScript source, not a wrapper around the Node binary.
+
+[![PyPI version](https://img.shields.io/pypi/v/inferbench-cli.svg)](https://pypi.org/project/inferbench-cli/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/RudrenduPaul/InferBench/blob/main/LICENSE)
+[![Python versions](https://img.shields.io/pypi/pyversions/inferbench-cli.svg)](https://pypi.org/project/inferbench-cli/)
+[![CI](https://github.com/RudrenduPaul/InferBench/actions/workflows/ci.yml/badge.svg)](https://github.com/RudrenduPaul/InferBench/actions/workflows/ci.yml)
+
+## Why this exists
+
+Every local-inference engine publishes its own benchmark numbers, on its
+own hardware, in its own README. None of them tell you which engine is
+actually fastest on the machine sitting in front of you. InferBench starts
+each engine's own OpenAI-compatible HTTP server on `127.0.0.1`, runs a
+fixed, varied 8-prompt set through the exact same measurement code against
+every engine, and reports the real, measured tokens/second -- not a number
+copied from a blog post.
+
+**Supported engines today: `omlx` and `llama.cpp`.** That is the complete
+list this v0.1 release supports -- see [docs/concepts.md](https://github.com/RudrenduPaul/InferBench/blob/main/docs/concepts.md)
+for why each engine needed its own adapter and what each one's real
+constraints are.
+
+## Install
+
+```bash
+pip install inferbench-cli
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add inferbench-cli
+```
+
+**Publish status, stated plainly**: this package is built, tested, and
+verified end to end (see "Verified" in
+[CHANGELOG.md](https://github.com/RudrenduPaul/InferBench/blob/main/CHANGELOG.md)),
+but the first publish attempt was rejected by PyPI with `429 Too many new
+projects created` -- a registry-side abuse throttle on this account, not a
+problem with the package. Publish will be retried once that limit clears;
+until then, `pip install inferbench-cli` will 404. Build it yourself from
+source in the meantime: `pip install
+git+https://github.com/RudrenduPaul/InferBench.git#subdirectory=python`.
+
+Zero third-party dependencies -- the CLI, the HTTP harness, and the
+hardware detector are all built on the Python standard library
+(`argparse`, `urllib.request`, `subprocess`, `os`). The complementary
+JS/TS distribution installs the same way on the npm side:
+`npm install -g inferbench-cli` (or `npx inferbench-cli run ...` to run it
+once without installing) -- see the
+[project README](https://github.com/RudrenduPaul/InferBench#readme) for
+that package. Both are meant to be first-class, maintained together.
+**Honest note on the npm package's current status**: at the time of this
+Python release, the npm package's own publish was blocked by a transient
+npm-registry rate limit (`E429`), unrelated to code readiness -- the code
+itself was already built and verified from a local tarball install. That
+is a registry-side issue tracked separately from this PyPI release, which
+is unaffected by it.
+
+Either package still requires at least one supported engine already
+installed on your machine -- neither package installs an inference engine
+for you:
+
+- **llama.cpp**: `brew install llama.cpp` (macOS) or build from
+  [ggml-org/llama.cpp](https://github.com/ggml-org/llama.cpp)
+- **omlx**: `brew tap jundot/omlx https://github.com/jundot/omlx && brew install omlx`
+  (Apple Silicon only)
+
+## Quickstart
+
+```bash
+# llama.cpp -- pass a Hugging Face repo spec; llama.cpp downloads and
+# caches it automatically, no manual step required
+inferbench run --engines llama.cpp --model "bartowski/Qwen2.5-1.5B-Instruct-GGUF:Q4_K_M"
+
+# omlx -- pass the model-directory subdirectory name under ~/.omlx/models/;
+# omlx has no CLI download flow, so the model must already be present there
+inferbench run --engines omlx --model "qwen2.5-1.5b-instruct-4bit"
+
+# Both installed engines, machine-readable output, saved to a file
+inferbench run --model "<spec>" --json --out report.json
+```
+
+**Known v0.1 limitation, carried over from the npm package and equally
+true here:** `--model` means something different per engine (a
+downloadable Hugging Face spec for llama.cpp, a pre-downloaded local
+directory name for omlx), because the two engines have genuinely different
+model-acquisition capabilities.
+
+Or call the library directly (the agent-native path):
+
+```python
+from inferbench import benchmark_engine, detect_hardware, all_engines, recommend
+
+hardware = detect_hardware()
+results = [
+    benchmark_engine(adapter, model="qwen2.5-1.5b-instruct-4bit")
+    for adapter in all_engines()
+]
+best = recommend(results)
+if best:
+    print(f"{best.engine}: {best.reason}")
+```
+
+## CLI command reference
+
+```
+inferbench run [options]
+
+Options:
+  --model <spec>    Model spec (engine-specific, see Quickstart above)   [required]
+  --engines <list>  Comma-separated engines to test (default: all installed --
+                     omlx, llama.cpp)
+  --max-tokens <n>  Max completion tokens per prompt (default: 200)
+  --json            Output machine-readable JSON instead of a human table
+  --out <file>      Also write the full JSON report to this file
+  --verbose         Show raw engine server stdout/stderr
+```
+
+Exit code `0` on a successful run with at least one engine tested; `1` on
+a resolvable usage error (e.g. an unknown `--engines` name) or when no
+supported engine is installed. **One documented divergence from the npm
+CLI**: a missing required flag (e.g. no `--model` at all) exits `2` here,
+the standard `argparse`/Unix convention for a parse-time error, rather than
+the npm CLI's `1` for the same case -- see
+[docs/concepts.md](https://github.com/RudrenduPaul/InferBench/blob/main/docs/concepts.md)
+for the full exit-code table.
+
+## How the measurement works
+
+Same architecture as the npm package, ported faithfully: InferBench does
+not shell out to each engine's own benchmark tool and parse its output --
+`omlx` has no CLI benchmark command at all (verified against its real
+README; its "Performance Benchmark" feature is a GUI-only, one-click
+action in its admin dashboard). Instead, this package starts each engine's
+own already-standardized OpenAI-compatible HTTP server (`omlx serve`,
+`llama-server`) and sends the exact same prompts through the exact same
+measurement code to every engine, timing the full response -- not just
+time-to-first-byte. The original TypeScript harness had a real bug here
+once (measuring right after `fetch()` resolved, which only captures HTTP
+headers arriving, produced a physically impossible 64,646 tok/s during a
+live end-to-end run before it was caught and fixed); this port measures
+after the full response body is read, and a regression test
+(`tests/test_measure.py`) asserts that gap is never reintroduced.
+
+## What "recommended" means (and doesn't)
+
+The recommendation names the engine with the highest measured average
+tokens/second **on this specific run, this specific hardware, this
+specific model** -- not a general claim about which engine is best. A
+different model, a different machine, or different thermal conditions can
+change the answer.
+
+## Security
+
+Neither this package nor the npm package ever `eval()`s, dynamically
+imports, or shells through a string -- every subprocess call
+(`llama-server`, `omlx`) is a fixed argv list (`subprocess.Popen([command,
+*args], ...)`), never a shell string, so a `--model` value cannot inject
+additional shell commands. **Honest note**: this project does not
+currently publish SLSA provenance, Sigstore signatures, or an SBOM, and
+has no OpenSSF Scorecard badge set up -- none of that infrastructure
+exists yet for either distribution, so it isn't claimed here. See
+[SECURITY.md](https://github.com/RudrenduPaul/InferBench/blob/main/SECURITY.md)
+for the vulnerability-reporting process.
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/RudrenduPaul/InferBench/blob/main/CONTRIBUTING.md).
+
+```bash
+cd python
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+Apache 2.0, see [LICENSE](https://github.com/RudrenduPaul/InferBench/blob/main/LICENSE).

inferbench_cli-0.1.0/README.md

@@ -0,0 +1,186 @@
+# inferbench-cli (Python)
+
+Vendor-neutral benchmark for local-LLM-inference engines -- measures real
+tokens/second for `omlx` and `llama.cpp` on your own hardware, live, and
+recommends the faster engine for your exact machine and model. This
+package is the Python distribution -- a genuine, independent port of the
+npm package's TypeScript source, not a wrapper around the Node binary.
+
+[![PyPI version](https://img.shields.io/pypi/v/inferbench-cli.svg)](https://pypi.org/project/inferbench-cli/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/RudrenduPaul/InferBench/blob/main/LICENSE)
+[![Python versions](https://img.shields.io/pypi/pyversions/inferbench-cli.svg)](https://pypi.org/project/inferbench-cli/)
+[![CI](https://github.com/RudrenduPaul/InferBench/actions/workflows/ci.yml/badge.svg)](https://github.com/RudrenduPaul/InferBench/actions/workflows/ci.yml)
+
+## Why this exists
+
+Every local-inference engine publishes its own benchmark numbers, on its
+own hardware, in its own README. None of them tell you which engine is
+actually fastest on the machine sitting in front of you. InferBench starts
+each engine's own OpenAI-compatible HTTP server on `127.0.0.1`, runs a
+fixed, varied 8-prompt set through the exact same measurement code against
+every engine, and reports the real, measured tokens/second -- not a number
+copied from a blog post.
+
+**Supported engines today: `omlx` and `llama.cpp`.** That is the complete
+list this v0.1 release supports -- see [docs/concepts.md](https://github.com/RudrenduPaul/InferBench/blob/main/docs/concepts.md)
+for why each engine needed its own adapter and what each one's real
+constraints are.
+
+## Install
+
+```bash
+pip install inferbench-cli
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add inferbench-cli
+```
+
+**Publish status, stated plainly**: this package is built, tested, and
+verified end to end (see "Verified" in
+[CHANGELOG.md](https://github.com/RudrenduPaul/InferBench/blob/main/CHANGELOG.md)),
+but the first publish attempt was rejected by PyPI with `429 Too many new
+projects created` -- a registry-side abuse throttle on this account, not a
+problem with the package. Publish will be retried once that limit clears;
+until then, `pip install inferbench-cli` will 404. Build it yourself from
+source in the meantime: `pip install
+git+https://github.com/RudrenduPaul/InferBench.git#subdirectory=python`.
+
+Zero third-party dependencies -- the CLI, the HTTP harness, and the
+hardware detector are all built on the Python standard library
+(`argparse`, `urllib.request`, `subprocess`, `os`). The complementary
+JS/TS distribution installs the same way on the npm side:
+`npm install -g inferbench-cli` (or `npx inferbench-cli run ...` to run it
+once without installing) -- see the
+[project README](https://github.com/RudrenduPaul/InferBench#readme) for
+that package. Both are meant to be first-class, maintained together.
+**Honest note on the npm package's current status**: at the time of this
+Python release, the npm package's own publish was blocked by a transient
+npm-registry rate limit (`E429`), unrelated to code readiness -- the code
+itself was already built and verified from a local tarball install. That
+is a registry-side issue tracked separately from this PyPI release, which
+is unaffected by it.
+
+Either package still requires at least one supported engine already
+installed on your machine -- neither package installs an inference engine
+for you:
+
+- **llama.cpp**: `brew install llama.cpp` (macOS) or build from
+  [ggml-org/llama.cpp](https://github.com/ggml-org/llama.cpp)
+- **omlx**: `brew tap jundot/omlx https://github.com/jundot/omlx && brew install omlx`
+  (Apple Silicon only)
+
+## Quickstart
+
+```bash
+# llama.cpp -- pass a Hugging Face repo spec; llama.cpp downloads and
+# caches it automatically, no manual step required
+inferbench run --engines llama.cpp --model "bartowski/Qwen2.5-1.5B-Instruct-GGUF:Q4_K_M"
+
+# omlx -- pass the model-directory subdirectory name under ~/.omlx/models/;
+# omlx has no CLI download flow, so the model must already be present there
+inferbench run --engines omlx --model "qwen2.5-1.5b-instruct-4bit"
+
+# Both installed engines, machine-readable output, saved to a file
+inferbench run --model "<spec>" --json --out report.json
+```
+
+**Known v0.1 limitation, carried over from the npm package and equally
+true here:** `--model` means something different per engine (a
+downloadable Hugging Face spec for llama.cpp, a pre-downloaded local
+directory name for omlx), because the two engines have genuinely different
+model-acquisition capabilities.
+
+Or call the library directly (the agent-native path):
+
+```python
+from inferbench import benchmark_engine, detect_hardware, all_engines, recommend
+
+hardware = detect_hardware()
+results = [
+    benchmark_engine(adapter, model="qwen2.5-1.5b-instruct-4bit")
+    for adapter in all_engines()
+]
+best = recommend(results)
+if best:
+    print(f"{best.engine}: {best.reason}")
+```
+
+## CLI command reference
+
+```
+inferbench run [options]
+
+Options:
+  --model <spec>    Model spec (engine-specific, see Quickstart above)   [required]
+  --engines <list>  Comma-separated engines to test (default: all installed --
+                     omlx, llama.cpp)
+  --max-tokens <n>  Max completion tokens per prompt (default: 200)
+  --json            Output machine-readable JSON instead of a human table
+  --out <file>      Also write the full JSON report to this file
+  --verbose         Show raw engine server stdout/stderr
+```
+
+Exit code `0` on a successful run with at least one engine tested; `1` on
+a resolvable usage error (e.g. an unknown `--engines` name) or when no
+supported engine is installed. **One documented divergence from the npm
+CLI**: a missing required flag (e.g. no `--model` at all) exits `2` here,
+the standard `argparse`/Unix convention for a parse-time error, rather than
+the npm CLI's `1` for the same case -- see
+[docs/concepts.md](https://github.com/RudrenduPaul/InferBench/blob/main/docs/concepts.md)
+for the full exit-code table.
+
+## How the measurement works
+
+Same architecture as the npm package, ported faithfully: InferBench does
+not shell out to each engine's own benchmark tool and parse its output --
+`omlx` has no CLI benchmark command at all (verified against its real
+README; its "Performance Benchmark" feature is a GUI-only, one-click
+action in its admin dashboard). Instead, this package starts each engine's
+own already-standardized OpenAI-compatible HTTP server (`omlx serve`,
+`llama-server`) and sends the exact same prompts through the exact same
+measurement code to every engine, timing the full response -- not just
+time-to-first-byte. The original TypeScript harness had a real bug here
+once (measuring right after `fetch()` resolved, which only captures HTTP
+headers arriving, produced a physically impossible 64,646 tok/s during a
+live end-to-end run before it was caught and fixed); this port measures
+after the full response body is read, and a regression test
+(`tests/test_measure.py`) asserts that gap is never reintroduced.
+
+## What "recommended" means (and doesn't)
+
+The recommendation names the engine with the highest measured average
+tokens/second **on this specific run, this specific hardware, this
+specific model** -- not a general claim about which engine is best. A
+different model, a different machine, or different thermal conditions can
+change the answer.
+
+## Security
+
+Neither this package nor the npm package ever `eval()`s, dynamically
+imports, or shells through a string -- every subprocess call
+(`llama-server`, `omlx`) is a fixed argv list (`subprocess.Popen([command,
+*args], ...)`), never a shell string, so a `--model` value cannot inject
+additional shell commands. **Honest note**: this project does not
+currently publish SLSA provenance, Sigstore signatures, or an SBOM, and
+has no OpenSSF Scorecard badge set up -- none of that infrastructure
+exists yet for either distribution, so it isn't claimed here. See
+[SECURITY.md](https://github.com/RudrenduPaul/InferBench/blob/main/SECURITY.md)
+for the vulnerability-reporting process.
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/RudrenduPaul/InferBench/blob/main/CONTRIBUTING.md).
+
+```bash
+cd python
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+Apache 2.0, see [LICENSE](https://github.com/RudrenduPaul/InferBench/blob/main/LICENSE).

inferbench_cli-0.1.0/examples/README.md

@@ -0,0 +1,31 @@
+# Python examples
+
+Each numbered subdirectory is a real, runnable script against the actual
+`inferbench` Python library (`from inferbench import benchmark_engine,
+...`), not pseudocode. Every script talks to whichever engines are
+actually installed on your machine -- none of them fabricate output when
+an engine isn't present; they report `not installed` plainly instead.
+
+Install the package first (editable install from this checkout, or `pip
+install inferbench-cli` from PyPI both work identically):
+
+```bash
+cd python
+pip install -e .
+```
+
+Then run any example directly (you need at least one of `omlx` or
+`llama.cpp` installed, plus a model already available to it -- see the
+[project README](../../README.md) for install instructions per engine):
+
+```bash
+python3 examples/01-basic-run/run.py qwen2.5-1.5b-instruct-4bit
+python3 examples/02-ci-gate/gate.py qwen2.5-1.5b-instruct-4bit 20
+python3 examples/03-json-report/report.py qwen2.5-1.5b-instruct-4bit report.json
+```
+
+| Example | What it demonstrates |
+| --- | --- |
+| [01-basic-run](./01-basic-run/) | The core library calls: `detect_hardware()`, `benchmark_engine()` per installed engine, `recommend()`, printing a human-readable summary -- the same functions `inferbench run` itself calls internally. |
+| [02-ci-gate](./02-ci-gate/) | Using the library as a performance-floor gate: fail (non-zero exit) if the best measured throughput falls below a minimum tok/s, suitable for a scheduled job on fixed hardware (see [docs/integrations/ci.md](../../docs/integrations/ci.md) for why this is not recommended as a per-PR gate). |
+| [03-json-report](./03-json-report/) | The agent-native use case: building a full `BenchmarkReport` in-process and serializing it to JSON with the same camelCase field names the npm CLI's `--json` output uses. |