brasskey 0.1.0a1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. brasskey-0.1.0a1/.gitignore +27 -0
  2. brasskey-0.1.0a1/CONTRIBUTING.md +98 -0
  3. brasskey-0.1.0a1/LICENSE +202 -0
  4. brasskey-0.1.0a1/NOTICE +65 -0
  5. brasskey-0.1.0a1/PKG-INFO +150 -0
  6. brasskey-0.1.0a1/README.md +108 -0
  7. brasskey-0.1.0a1/SECURITY.md +101 -0
  8. brasskey-0.1.0a1/hatch_build.py +51 -0
  9. brasskey-0.1.0a1/pyproject.toml +172 -0
  10. brasskey-0.1.0a1/schemas/brasskey.lock.schema.json +727 -0
  11. brasskey-0.1.0a1/schemas/brasskey.yaml.schema.json +165 -0
  12. brasskey-0.1.0a1/scripts/build-constraints.txt +29 -0
  13. brasskey-0.1.0a1/scripts/check_dist.py +110 -0
  14. brasskey-0.1.0a1/scripts/check_licenses.py +235 -0
  15. brasskey-0.1.0a1/scripts/export_schemas.py +23 -0
  16. brasskey-0.1.0a1/scripts/refresh_catalog.py +142 -0
  17. brasskey-0.1.0a1/src/brasskey/__init__.py +11 -0
  18. brasskey-0.1.0a1/src/brasskey/__main__.py +6 -0
  19. brasskey-0.1.0a1/src/brasskey/bench/__init__.py +2 -0
  20. brasskey-0.1.0a1/src/brasskey/bench/analysis.py +101 -0
  21. brasskey-0.1.0a1/src/brasskey/bench/endpoint.py +133 -0
  22. brasskey-0.1.0a1/src/brasskey/bench/guidellm.py +367 -0
  23. brasskey-0.1.0a1/src/brasskey/bench/models.py +132 -0
  24. brasskey-0.1.0a1/src/brasskey/bench/runner.py +73 -0
  25. brasskey-0.1.0a1/src/brasskey/bench/stats.py +230 -0
  26. brasskey-0.1.0a1/src/brasskey/bench/tokenizer.py +101 -0
  27. brasskey-0.1.0a1/src/brasskey/cli/__init__.py +2 -0
  28. brasskey-0.1.0a1/src/brasskey/cli/app.py +229 -0
  29. brasskey-0.1.0a1/src/brasskey/cli/bench.py +591 -0
  30. brasskey-0.1.0a1/src/brasskey/cli/doctor.py +174 -0
  31. brasskey-0.1.0a1/src/brasskey/cli/options.py +49 -0
  32. brasskey-0.1.0a1/src/brasskey/cli/run.py +766 -0
  33. brasskey-0.1.0a1/src/brasskey/config/__init__.py +2 -0
  34. brasskey-0.1.0a1/src/brasskey/config/intent.py +80 -0
  35. brasskey-0.1.0a1/src/brasskey/config/io.py +89 -0
  36. brasskey-0.1.0a1/src/brasskey/config/lock.py +108 -0
  37. brasskey-0.1.0a1/src/brasskey/config/schema.py +34 -0
  38. brasskey-0.1.0a1/src/brasskey/engines/__init__.py +6 -0
  39. brasskey-0.1.0a1/src/brasskey/engines/base.py +204 -0
  40. brasskey-0.1.0a1/src/brasskey/engines/capabilities.py +224 -0
  41. brasskey-0.1.0a1/src/brasskey/engines/docker.py +216 -0
  42. brasskey-0.1.0a1/src/brasskey/engines/gpu_failures.py +113 -0
  43. brasskey-0.1.0a1/src/brasskey/engines/gpu_server.py +130 -0
  44. brasskey-0.1.0a1/src/brasskey/engines/llamacpp.py +247 -0
  45. brasskey-0.1.0a1/src/brasskey/engines/mlx.py +306 -0
  46. brasskey-0.1.0a1/src/brasskey/engines/pyenv.py +74 -0
  47. brasskey-0.1.0a1/src/brasskey/engines/registry.py +94 -0
  48. brasskey-0.1.0a1/src/brasskey/engines/sglang.py +177 -0
  49. brasskey-0.1.0a1/src/brasskey/engines/types.py +67 -0
  50. brasskey-0.1.0a1/src/brasskey/engines/vllm.py +176 -0
  51. brasskey-0.1.0a1/src/brasskey/errors.py +76 -0
  52. brasskey-0.1.0a1/src/brasskey/hardware/__init__.py +31 -0
  53. brasskey-0.1.0a1/src/brasskey/hardware/apple.py +165 -0
  54. brasskey-0.1.0a1/src/brasskey/hardware/commands.py +81 -0
  55. brasskey-0.1.0a1/src/brasskey/hardware/cpu.py +396 -0
  56. brasskey-0.1.0a1/src/brasskey/hardware/nvidia.py +469 -0
  57. brasskey-0.1.0a1/src/brasskey/hardware/osinfo.py +46 -0
  58. brasskey-0.1.0a1/src/brasskey/hardware/probe.py +123 -0
  59. brasskey-0.1.0a1/src/brasskey/hardware/types.py +175 -0
  60. brasskey-0.1.0a1/src/brasskey/log.py +80 -0
  61. brasskey-0.1.0a1/src/brasskey/models/__init__.py +2 -0
  62. brasskey-0.1.0a1/src/brasskey/models/architecture.py +107 -0
  63. brasskey-0.1.0a1/src/brasskey/models/catalog.py +46 -0
  64. brasskey-0.1.0a1/src/brasskey/models/catalog.yaml +1123 -0
  65. brasskey-0.1.0a1/src/brasskey/models/download.py +139 -0
  66. brasskey-0.1.0a1/src/brasskey/models/fetch.py +120 -0
  67. brasskey-0.1.0a1/src/brasskey/models/fit.py +297 -0
  68. brasskey-0.1.0a1/src/brasskey/models/hub.py +445 -0
  69. brasskey-0.1.0a1/src/brasskey/models/types.py +150 -0
  70. brasskey-0.1.0a1/src/brasskey/output/__init__.py +6 -0
  71. brasskey-0.1.0a1/src/brasskey/output/bench.py +167 -0
  72. brasskey-0.1.0a1/src/brasskey/output/confirm.py +46 -0
  73. brasskey-0.1.0a1/src/brasskey/output/envelope.py +48 -0
  74. brasskey-0.1.0a1/src/brasskey/output/hardware.py +120 -0
  75. brasskey-0.1.0a1/src/brasskey/output/next_step.py +27 -0
  76. brasskey-0.1.0a1/src/brasskey/output/plan.py +166 -0
  77. brasskey-0.1.0a1/src/brasskey/output/progress.py +59 -0
  78. brasskey-0.1.0a1/src/brasskey/output/render.py +112 -0
  79. brasskey-0.1.0a1/src/brasskey/output/result.py +25 -0
  80. brasskey-0.1.0a1/src/brasskey/output/run.py +144 -0
  81. brasskey-0.1.0a1/src/brasskey/output/security.py +46 -0
  82. brasskey-0.1.0a1/src/brasskey/output/settings.py +70 -0
  83. brasskey-0.1.0a1/src/brasskey/paths.py +57 -0
  84. brasskey-0.1.0a1/src/brasskey/planner/__init__.py +12 -0
  85. brasskey-0.1.0a1/src/brasskey/planner/replay.py +184 -0
  86. brasskey-0.1.0a1/src/brasskey/planner/select.py +419 -0
  87. brasskey-0.1.0a1/src/brasskey/py.typed +0 -0
  88. brasskey-0.1.0a1/src/brasskey/runtime/__init__.py +2 -0
  89. brasskey-0.1.0a1/src/brasskey/runtime/foreground.py +48 -0
  90. brasskey-0.1.0a1/src/brasskey/runtime/ports.py +59 -0
  91. brasskey-0.1.0a1/src/brasskey/runtime/proxy.py +264 -0
  92. brasskey-0.1.0a1/src/brasskey/runtime/setup.py +65 -0
  93. brasskey-0.1.0a1/src/brasskey/runtime/state.py +89 -0
  94. brasskey-0.1.0a1/src/brasskey/runtime/supervisor.py +230 -0
  95. brasskey-0.1.0a1/src/brasskey/security/__init__.py +2 -0
  96. brasskey-0.1.0a1/src/brasskey/security/apikeys.py +110 -0
  97. brasskey-0.1.0a1/src/brasskey/security/doctor.py +639 -0
  98. brasskey-0.1.0a1/src/brasskey/security/netinfo.py +238 -0
  99. brasskey-0.1.0a1/src/brasskey/security/policy.py +155 -0
  100. brasskey-0.1.0a1/tests/conftest.py +133 -0
  101. brasskey-0.1.0a1/tests/fakes/__init__.py +7 -0
  102. brasskey-0.1.0a1/tests/fakes/commands.py +56 -0
  103. brasskey-0.1.0a1/tests/fakes/engine.py +216 -0
  104. brasskey-0.1.0a1/tests/fakes/fake_engine.py +124 -0
  105. brasskey-0.1.0a1/tests/fakes/fake_guidellm.py +51 -0
  106. brasskey-0.1.0a1/tests/fakes/helpers.py +23 -0
  107. brasskey-0.1.0a1/tests/fakes/hub.py +133 -0
  108. brasskey-0.1.0a1/tests/fakes/machines.py +106 -0
  109. brasskey-0.1.0a1/tests/fakes/nvml.py +118 -0
  110. brasskey-0.1.0a1/tests/fakes/system.py +24 -0
  111. brasskey-0.1.0a1/tests/fixtures/bench/guidellm-0.8.1-report.json +6559 -0
  112. brasskey-0.1.0a1/tests/fixtures/configs/deepseek-v3.json +1 -0
  113. brasskey-0.1.0a1/tests/fixtures/configs/gemma-3-12b.json +1 -0
  114. brasskey-0.1.0a1/tests/fixtures/configs/gpt-oss-20b.json +1 -0
  115. brasskey-0.1.0a1/tests/fixtures/configs/gpt2-style.json +1 -0
  116. brasskey-0.1.0a1/tests/fixtures/configs/llama-3-70b.json +1 -0
  117. brasskey-0.1.0a1/tests/fixtures/configs/qwen3-30b-a3b.json +1 -0
  118. brasskey-0.1.0a1/tests/fixtures/configs/qwen3-4b-awq.json +1 -0
  119. brasskey-0.1.0a1/tests/fixtures/configs/qwen3-4b-mlx-4bit.json +1 -0
  120. brasskey-0.1.0a1/tests/fixtures/configs/qwen3-4b.json +1 -0
  121. brasskey-0.1.0a1/tests/fixtures/engines/llamacpp-0.9.0-m3pro.devices +3 -0
  122. brasskey-0.1.0a1/tests/fixtures/engines/llamacpp-0.9.0.help +753 -0
  123. brasskey-0.1.0a1/tests/fixtures/engines/llamacpp-0.9.0.version +2 -0
  124. brasskey-0.1.0a1/tests/fixtures/engines/mlx-lm-0.32.2-m3pro.probe.json +1 -0
  125. brasskey-0.1.0a1/tests/fixtures/engines/mlx-lm-0.32.2.help +79 -0
  126. brasskey-0.1.0a1/tests/fixtures/hardware/linux-epyc-7r32.cpuinfo +21 -0
  127. brasskey-0.1.0a1/tests/fixtures/hardware/linux-graviton3.cpuinfo +14 -0
  128. brasskey-0.1.0a1/tests/fixtures/hardware/linux-unknown-arm.cpuinfo +7 -0
  129. brasskey-0.1.0a1/tests/fixtures/hardware/linux-xeon-8488c.cpuinfo +6 -0
  130. brasskey-0.1.0a1/tests/fixtures/hardware/macos-intel-i9.sysctl +7 -0
  131. brasskey-0.1.0a1/tests/fixtures/hardware/macos-m1-virtual.sysctl +9 -0
  132. brasskey-0.1.0a1/tests/fixtures/hardware/macos-m3-pro.ioreg +2 -0
  133. brasskey-0.1.0a1/tests/fixtures/hardware/macos-m3-pro.sysctl +16 -0
  134. brasskey-0.1.0a1/tests/fixtures/hardware/ubuntu-24.04.os-release +6 -0
  135. brasskey-0.1.0a1/tests/integration/test_bench_real.py +66 -0
  136. brasskey-0.1.0a1/tests/integration/test_engine_llamacpp.py +94 -0
  137. brasskey-0.1.0a1/tests/integration/test_engine_mlx.py +87 -0
  138. brasskey-0.1.0a1/tests/integration/test_engine_nvidia.py +122 -0
  139. brasskey-0.1.0a1/tests/integration/test_hw_real.py +40 -0
  140. brasskey-0.1.0a1/tests/integration/test_models_network.py +37 -0
  141. brasskey-0.1.0a1/tests/unit/test_bench.py +444 -0
  142. brasskey-0.1.0a1/tests/unit/test_cli_bench.py +268 -0
  143. brasskey-0.1.0a1/tests/unit/test_cli_contract.py +60 -0
  144. brasskey-0.1.0a1/tests/unit/test_cli_doctor.py +105 -0
  145. brasskey-0.1.0a1/tests/unit/test_cli_errors.py +123 -0
  146. brasskey-0.1.0a1/tests/unit/test_cli_run.py +403 -0
  147. brasskey-0.1.0a1/tests/unit/test_cli_version_help.py +84 -0
  148. brasskey-0.1.0a1/tests/unit/test_config.py +117 -0
  149. brasskey-0.1.0a1/tests/unit/test_engines_gpu.py +422 -0
  150. brasskey-0.1.0a1/tests/unit/test_engines_llamacpp.py +210 -0
  151. brasskey-0.1.0a1/tests/unit/test_engines_mlx.py +254 -0
  152. brasskey-0.1.0a1/tests/unit/test_hw_apple.py +125 -0
  153. brasskey-0.1.0a1/tests/unit/test_hw_cpu.py +249 -0
  154. brasskey-0.1.0a1/tests/unit/test_hw_nvidia.py +205 -0
  155. brasskey-0.1.0a1/tests/unit/test_hw_probe.py +131 -0
  156. brasskey-0.1.0a1/tests/unit/test_models_architecture.py +125 -0
  157. brasskey-0.1.0a1/tests/unit/test_models_catalog.py +64 -0
  158. brasskey-0.1.0a1/tests/unit/test_models_download.py +104 -0
  159. brasskey-0.1.0a1/tests/unit/test_models_fetch.py +63 -0
  160. brasskey-0.1.0a1/tests/unit/test_models_fit.py +192 -0
  161. brasskey-0.1.0a1/tests/unit/test_models_hub.py +150 -0
  162. brasskey-0.1.0a1/tests/unit/test_output.py +114 -0
  163. brasskey-0.1.0a1/tests/unit/test_packaging.py +138 -0
  164. brasskey-0.1.0a1/tests/unit/test_planner.py +215 -0
  165. brasskey-0.1.0a1/tests/unit/test_planner_replay.py +70 -0
  166. brasskey-0.1.0a1/tests/unit/test_proxy.py +163 -0
  167. brasskey-0.1.0a1/tests/unit/test_repo_policy.py +135 -0
  168. brasskey-0.1.0a1/tests/unit/test_runtime.py +323 -0
  169. brasskey-0.1.0a1/tests/unit/test_security_doctor.py +294 -0
  170. brasskey-0.1.0a1/tests/unit/test_security_keys.py +157 -0
@@ -0,0 +1,27 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ build/
6
+ dist/
7
+
8
+ # Environments (uv creates .venv; uv.lock IS committed)
9
+ .venv/
10
+
11
+ # Tool caches and reports
12
+ .pytest_cache/
13
+ .ruff_cache/
14
+ .coverage
15
+ .coverage.*
16
+ coverage.xml
17
+ htmlcov/
18
+
19
+ # Editors and OS
20
+ .idea/
21
+ .vscode/
22
+ *.swp
23
+ .DS_Store
24
+
25
+ # Local secrets (API keys come from env vars or the OS keyring; never commit them)
26
+ .env
27
+ .env.*
@@ -0,0 +1,98 @@
1
+ # Contributing to Brasskey
2
+
3
+ Thanks for your interest! Brasskey is pre-alpha and moving fast toward v0.1 "It runs". This page
4
+ covers how to set up, the rules every change follows, and how contributions are licensed.
5
+
6
+ ## Scope first
7
+
8
+ We build one milestone at a time (see the Status section of the README). Anything outside the
9
+ current milestone waits; something moves earlier only if a design partner needs it and something of
10
+ equal size moves later. If you want to propose a bigger change, open an issue or write a short
11
+ proposal in `docs/decisions/` before writing code.
12
+
13
+ ## Set up
14
+
15
+ You need [uv](https://docs.astral.sh/uv/) 0.13.6 or newer (`uv self update`).
16
+
17
+ ```bash
18
+ uv sync # create .venv with runtime + dev dependencies from uv.lock
19
+ uv run brasskey --help # run the CLI from source
20
+ ```
21
+
22
+ uv uses its own managed Python builds for this project (`python-preference = "only-managed"`), so
23
+ an active conda or system Python does not leak into the environment.
24
+
25
+ ## Everyday commands
26
+
27
+ ```bash
28
+ uv run pytest # unit tests; no GPU needed
29
+ uv run pytest -m gpu # real NVIDIA tests (opt-in)
30
+ uv run pytest -m engine # real engine + small model download (opt-in)
31
+ uv run ruff check . && uv run ruff format --check .
32
+ uv run pyright # strict for src/ and scripts/
33
+ uv run python scripts/check_licenses.py # dependency license policy
34
+ uv build --build-constraints scripts/build-constraints.txt --require-hashes --no-create-gitignore
35
+ python3 scripts/check_dist.py dist # what a release would publish
36
+ ```
37
+
38
+ CI runs all of these on Linux and macOS (Apple Silicon) with Python 3.11 to 3.14. Releases are
39
+ published by CI only; see [RELEASING.md](RELEASING.md).
40
+
41
+ ## Rules every change follows
42
+
43
+ - **Tests:** every feature ships with tests that pass on a laptop without a GPU. Use fake hardware
44
+ probes and fake engine processes; mark real-hardware tests `@pytest.mark.gpu` (or `engine`,
45
+ `network`).
46
+ - **License header:** every `.py` file starts with `# SPDX-License-Identifier: Apache-2.0` (a test
47
+ checks this).
48
+ - **Engines stay out of process:** never import vLLM, SGLang, MLX, llama.cpp bindings, PyTorch or
49
+ GuideLLM into Brasskey. They run as subprocesses or containers behind an adapter. Ruff enforces
50
+ this (`TID251`).
51
+ - **CLI contract:** every command supports `--json`, ends with a one-line `Next:` suggestion,
52
+ explains errors in plain language with a fix, and shows tracebacks only with `--debug`.
53
+ - **Measure, don't guess:** recommendations are backed by a measurement or clearly labeled as an
54
+ estimate.
55
+ - **Privacy:** never log or store prompt content, API keys or tokens.
56
+ - **Secure defaults:** servers bind to `127.0.0.1`; any other address requires an API key. Keys
57
+ come from environment variables or the OS keyring and never appear on command lines, in logs or
58
+ in lock files. Telemetry is off; nothing leaves the machine without explicit opt-in.
59
+ - **Reproducible deployments:** `brasskey.yaml` (intent) and `brasskey.lock` (resolved plan and
60
+ measured results) are Pydantic v2 models with exported JSON Schemas. After changing them, run
61
+ `uv run python scripts/export_schemas.py` and commit `schemas/`.
62
+ - **Supply chain:** GitHub Actions are pinned by full commit SHA and tools by exact version, and
63
+ `uv.lock` is committed (see also Dependencies below).
64
+ - **Naming:** "Brasskey" in prose, `brasskey` in code and commands. No `bk` alias.
65
+
66
+ ## Dependencies
67
+
68
+ Ask before adding a dependency (open an issue). It must be Apache-2.0, MIT or BSD compatible;
69
+ GPL and AGPL code or dependencies are never accepted, and code is never copied from GPL or AGPL
70
+ projects. Record the dependency and its license in `NOTICE`. The lock only resolves releases that
71
+ have been public for at least 7 days (`exclude-newer` in `pyproject.toml`).
72
+
73
+ ## Decisions
74
+
75
+ Record notable decisions as short ADRs in `docs/decisions/NNNN-title.md` using the template there.
76
+
77
+ ## Pull requests
78
+
79
+ Keep pull requests small and focused, fill in the template checklist, and make sure CI is green.
80
+ Write commit messages in the imperative mood ("Add hardware probe for Apple Silicon").
81
+
82
+ ## Contributor License Agreement
83
+
84
+ Brasskey uses a Contributor License Agreement (CLA) based on the Apache Software Foundation's
85
+ individual and corporate CLAs: you keep the copyright in your contribution and grant Prcept AI
86
+ LLP a broad license (including patents) to use and distribute it. A CLA bot will ask you to sign
87
+ once, on your first pull request.
88
+
89
+ The CLA bot is not set up yet, so **we cannot merge outside pull requests until it is**. Issues,
90
+ bug reports and discussions are very welcome in the meantime.
91
+
92
+ **Our pledge:** the Brasskey core is licensed under Apache 2.0 and stays Apache 2.0. Paid
93
+ features for organizations live in separate repositories and never change the license of this one.
94
+
95
+ ## Conduct and security
96
+
97
+ Everyone taking part follows our [Code of Conduct](CODE_OF_CONDUCT.md). Report security problems
98
+ privately as described in [SECURITY.md](SECURITY.md), never in a public issue.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,65 @@
1
+ Brasskey
2
+ Copyright 2026 Prcept AI LLP
3
+
4
+ This product includes software developed at Prcept AI LLP
5
+ (https://github.com/Prcept-AI/brasskey), licensed under the Apache License, Version 2.0.
6
+
7
+ -------------------------------------------------------------------------------
8
+ Inference engines and tools (launched as separate processes; not bundled)
9
+ -------------------------------------------------------------------------------
10
+
11
+ Brasskey starts the following projects as separate processes or containers. They are not
12
+ included in, linked into or redistributed with Brasskey, and they keep their own licenses:
13
+
14
+ llama.cpp MIT https://github.com/ggml-org/llama.cpp
15
+ MLX MIT https://github.com/ml-explore/mlx
16
+ mlx-lm MIT https://github.com/ml-explore/mlx-lm
17
+ vLLM Apache-2.0 https://github.com/vllm-project/vllm
18
+ SGLang Apache-2.0 https://github.com/sgl-project/sglang
19
+ GuideLLM Apache-2.0 https://github.com/vllm-project/guidellm
20
+
21
+ On macOS, mlx-lm is run through uv (MIT OR Apache-2.0, https://github.com/astral-sh/uv) in an
22
+ isolated, pinned environment when it isn't already installed; GuideLLM is run the same way
23
+ (with CPU-only PyTorch, BSD-3-Clause). uv is not bundled either.
24
+
25
+ Container images for vLLM and SGLang may contain NVIDIA CUDA libraries under NVIDIA's own
26
+ license terms. Users pull those images themselves; Brasskey does not redistribute them.
27
+
28
+ -------------------------------------------------------------------------------
29
+ Python dependencies (installed separately by pip or uv; not bundled)
30
+ -------------------------------------------------------------------------------
31
+
32
+ typer MIT https://github.com/fastapi/typer
33
+ (includes a vendored copy of Click, BSD-3-Clause)
34
+ rich MIT https://github.com/Textualize/rich
35
+ pydantic MIT https://github.com/pydantic/pydantic
36
+ psutil BSD-3-Clause https://github.com/giampaolo/psutil
37
+ nvidia-ml-py BSD-3-Clause https://pypi.org/project/nvidia-ml-py/
38
+ (NVIDIA's Python bindings for NVML; the NVML library itself ships
39
+ with the user's NVIDIA driver and is not redistributed)
40
+ httpx2 BSD-3-Clause https://github.com/pydantic/httpx2
41
+ (with httpcore2, BSD-3-Clause, and truststore, MIT)
42
+ PyYAML MIT https://github.com/yaml/pyyaml
43
+ platformdirs MIT https://github.com/tox-dev/platformdirs
44
+ huggingface_hub Apache-2.0 https://github.com/huggingface/huggingface_hub
45
+ (with hf-xet, Apache-2.0; tqdm, MPL-2.0 AND MIT, used unmodified)
46
+ uvicorn BSD-3-Clause https://github.com/Kludex/uvicorn
47
+ (with h11, MIT, and click, BSD-3-Clause)
48
+ Starlette BSD-3-Clause https://github.com/Kludex/starlette
49
+ (with anyio, MIT)
50
+ keyring MIT https://github.com/jaraco/keyring
51
+ (with jaraco.classes, jaraco.context, jaraco.functools and
52
+ more-itertools, MIT; on Linux also SecretStorage, BSD-3-Clause,
53
+ jeepney, MIT, and cryptography, Apache-2.0 OR BSD-3-Clause, with
54
+ cffi, MIT, and pycparser, BSD-3-Clause)
55
+
56
+ Model files are downloaded from Hugging Face by the user and keep their own licenses; the
57
+ Brasskey catalog stores only metadata (names, revisions, sizes, hashes), never weights.
58
+
59
+ -------------------------------------------------------------------------------
60
+ Brand assets
61
+ -------------------------------------------------------------------------------
62
+
63
+ The Brasskey logo outlines in brand/ are derived from Instrument Sans, licensed under the
64
+ SIL Open Font License 1.1 (see brand/licenses/OFL-InstrumentSans.txt). The Brasskey name and
65
+ logo are trademarks of Prcept AI LLP; see TRADEMARKS.md.
@@ -0,0 +1,150 @@
1
+ Metadata-Version: 2.5
2
+ Name: brasskey
3
+ Version: 0.1.0a1
4
+ Summary: The key to every engine: deploy, tune, verify and serve open models on any hardware.
5
+ Project-URL: Homepage, https://github.com/Prcept-AI/brasskey
6
+ Project-URL: Repository, https://github.com/Prcept-AI/brasskey
7
+ Project-URL: Issues, https://github.com/Prcept-AI/brasskey/issues
8
+ Project-URL: Security, https://github.com/Prcept-AI/brasskey/blob/main/SECURITY.md
9
+ Author: Prcept AI LLP
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ License-File: NOTICE
13
+ Keywords: benchmark,inference,llama.cpp,llm,mlx,openai-compatible,sglang,vllm
14
+ Classifier: Development Status :: 2 - Pre-Alpha
15
+ Classifier: Environment :: Console
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Intended Audience :: System Administrators
18
+ Classifier: Operating System :: MacOS
19
+ Classifier: Operating System :: POSIX :: Linux
20
+ Classifier: Programming Language :: Python :: 3
21
+ Classifier: Programming Language :: Python :: 3 :: Only
22
+ Classifier: Programming Language :: Python :: 3.11
23
+ Classifier: Programming Language :: Python :: 3.12
24
+ Classifier: Programming Language :: Python :: 3.13
25
+ Classifier: Programming Language :: Python :: 3.14
26
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
27
+ Classifier: Typing :: Typed
28
+ Requires-Python: >=3.11
29
+ Requires-Dist: httpx2>=2.16
30
+ Requires-Dist: huggingface-hub>=2.4
31
+ Requires-Dist: keyring>=25.7
32
+ Requires-Dist: nvidia-ml-py>=13.615
33
+ Requires-Dist: platformdirs>=4.14
34
+ Requires-Dist: psutil>=7.2
35
+ Requires-Dist: pydantic>=2.14
36
+ Requires-Dist: pyyaml>=6.0.3
37
+ Requires-Dist: rich>=15.0
38
+ Requires-Dist: starlette>=1.10
39
+ Requires-Dist: typer>=0.27
40
+ Requires-Dist: uvicorn>=0.54
41
+ Description-Content-Type: text/markdown
42
+
43
+ <br>
44
+
45
+ <p align="center">
46
+ <picture>
47
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Prcept-AI/brasskey/v0.1.0a1/brand/logo/brasskey-wordmark-on-dark.svg">
48
+ <img alt="Brasskey" src="https://raw.githubusercontent.com/Prcept-AI/brasskey/v0.1.0a1/brand/logo/brasskey-wordmark-on-light.svg" width="240">
49
+ </picture>
50
+ </p>
51
+
52
+ <p align="center"><b>The key to every engine.</b></p>
53
+
54
+ <br>
55
+
56
+ Brasskey is an open-source tool to deploy, tune, verify and serve open models on any hardware,
57
+ measured on your own traffic.
58
+
59
+ ```bash
60
+ brasskey run # try any model on your machine
61
+ brasskey switch # prove an open model can replace an expensive API (coming soon)
62
+ brasskey deploy # ship it tuned, verified and secure (coming soon)
63
+ ```
64
+
65
+ ## Status
66
+
67
+ Pre-alpha. 0.1.0a1 is the first release on PyPI, on the way to v0.1 "It runs": `brasskey run`,
68
+ `brasskey bench` and `brasskey doctor --security` on NVIDIA GPUs, Apple Silicon and CPUs, with
69
+ llama.cpp, MLX, vLLM and SGLang. Done so far:
70
+
71
+ - `brasskey doctor`: hardware, engines and running servers.
72
+ - Planning with `brasskey run --dry-run`.
73
+ - `brasskey run` with llama.cpp, MLX (Apple Silicon), vLLM or SGLang (NVIDIA on Linux, as a
74
+ process or from the official image pinned by digest). It downloads and verifies the model,
75
+ then serves it on 127.0.0.1 through a Brasskey proxy that enforces API keys. Ctrl-C stops it
76
+ cleanly. llama.cpp and MLX are tested on real hardware; vLLM and SGLang are not yet tested on
77
+ real GPUs.
78
+ - `brasskey doctor --security`: checks this machine, or a URL, for exposed model servers.
79
+ - `brasskey bench`: repeated GuideLLM runs, 95% intervals on every metric, and PASS / FAIL /
80
+ INCONCLUSIVE when comparing two setups.
81
+
82
+ Next: testing vLLM and SGLang on NVIDIA GPUs, then 0.1.0. Design decisions are recorded in
83
+ [docs/decisions](https://github.com/Prcept-AI/brasskey/tree/v0.1.0a1/docs/decisions/).
84
+
85
+ ## Install
86
+
87
+ Python 3.11 or newer, on macOS or Linux (Windows through WSL2):
88
+
89
+ ```bash
90
+ uv tool install brasskey # or: pip install brasskey
91
+ brasskey doctor # what Brasskey sees on this machine
92
+ brasskey run --dry-run # the model it would pick for this machine, and why
93
+ ```
94
+
95
+ `brasskey run` starts an engine you have installed, for example `brew install llama.cpp`; on
96
+ Apple Silicon, Brasskey can set up MLX itself if you have uv. `brasskey doctor` shows what's
97
+ installed and how to add the rest. Releases are signed and reproducible; see
98
+ [SECURITY.md](https://github.com/Prcept-AI/brasskey/blob/v0.1.0a1/SECURITY.md#verifying-a-release).
99
+
100
+ ## Try it from source
101
+
102
+ You need [uv](https://docs.astral.sh/uv/) 0.13.6 or newer.
103
+
104
+ ```bash
105
+ git clone https://github.com/Prcept-AI/brasskey.git
106
+ cd brasskey
107
+ uv sync
108
+ uv run brasskey --help
109
+ uv run brasskey doctor # what Brasskey sees on this machine (CPU, memory, GPUs)
110
+ uv run brasskey doctor --json
111
+ uv run brasskey run --dry-run # the model Brasskey would pick for this machine, and why
112
+ uv run brasskey run qwen3-14b --dry-run --context 32768
113
+ uv run brasskey run hf:Qwen/Qwen3-4B-GGUF:Q8_0 --dry-run # any Hugging Face repo
114
+
115
+ brew install llama.cpp # the engine (macOS or Linux)
116
+ uv run brasskey run qwen3-0.6b # download (639 MB), start, serve; Ctrl-C stops it
117
+ uv run brasskey run qwen3-4b --save # also writes brasskey.yaml + brasskey.lock
118
+ uv run brasskey run --engine mlx # Apple Silicon: MLX via uv, set up on first use
119
+ uv run brasskey run --engine vllm # NVIDIA on Linux: vLLM on PATH, or its pinned image
120
+
121
+ uv run brasskey bench http://127.0.0.1:8000/v1 --save base.json # measure a server
122
+ uv run brasskey bench http://127.0.0.1:8001/v1 --baseline base.json # PASS / FAIL / INCONCLUSIVE
123
+ uv run brasskey bench http://127.0.0.1:8001/v1 --compare http://127.0.0.1:8000/v1
124
+
125
+ uv run brasskey doctor --security # exposed model servers, keys, Docker, firewall
126
+ uv run brasskey doctor --security http://gpu-box:8000/v1 # check a server you run elsewhere
127
+ uv run brasskey run qwen3-4b --host 0.0.0.0 --generate-api-key # reachable from your network
128
+ ```
129
+
130
+ Every command supports `--json` (one JSON document on stdout), `--debug` (logs and full
131
+ tracebacks on stderr) and `--yes` (skip confirmations), and ends with a `Next:` suggestion.
132
+
133
+ ## Secure and private by default
134
+
135
+ Servers bind to `127.0.0.1`. Any other address requires a strong API key (from
136
+ `BRASSKEY_API_KEY` or your OS keychain, never a command-line argument). There is no telemetry,
137
+ and prompt content is never logged. See [SECURITY.md](https://github.com/Prcept-AI/brasskey/blob/v0.1.0a1/SECURITY.md).
138
+
139
+ ## Contributing
140
+
141
+ See [CONTRIBUTING.md](https://github.com/Prcept-AI/brasskey/blob/v0.1.0a1/CONTRIBUTING.md) and our [Code of Conduct](https://github.com/Prcept-AI/brasskey/blob/v0.1.0a1/CODE_OF_CONDUCT.md).
142
+
143
+ ## License and pledge
144
+
145
+ Apache-2.0 (see [LICENSE](https://github.com/Prcept-AI/brasskey/blob/v0.1.0a1/LICENSE) and [NOTICE](https://github.com/Prcept-AI/brasskey/blob/v0.1.0a1/NOTICE)). **The Brasskey core is Apache 2.0 and
146
+ stays Apache 2.0.** Paid features for organizations live in separate repositories and never
147
+ change the license of this one. The Brasskey name and logo are trademarks of Prcept AI LLP; see
148
+ [TRADEMARKS.md](https://github.com/Prcept-AI/brasskey/blob/v0.1.0a1/TRADEMARKS.md).
149
+
150
+ Made by Prcept AI LLP.
@@ -0,0 +1,108 @@
1
+ <br>
2
+
3
+ <p align="center">
4
+ <picture>
5
+ <source media="(prefers-color-scheme: dark)" srcset="brand/logo/brasskey-wordmark-on-dark.svg">
6
+ <img alt="Brasskey" src="brand/logo/brasskey-wordmark-on-light.svg" width="240">
7
+ </picture>
8
+ </p>
9
+
10
+ <p align="center"><b>The key to every engine.</b></p>
11
+
12
+ <br>
13
+
14
+ Brasskey is an open-source tool to deploy, tune, verify and serve open models on any hardware,
15
+ measured on your own traffic.
16
+
17
+ ```bash
18
+ brasskey run # try any model on your machine
19
+ brasskey switch # prove an open model can replace an expensive API (coming soon)
20
+ brasskey deploy # ship it tuned, verified and secure (coming soon)
21
+ ```
22
+
23
+ ## Status
24
+
25
+ Pre-alpha. 0.1.0a1 is the first release on PyPI, on the way to v0.1 "It runs": `brasskey run`,
26
+ `brasskey bench` and `brasskey doctor --security` on NVIDIA GPUs, Apple Silicon and CPUs, with
27
+ llama.cpp, MLX, vLLM and SGLang. Done so far:
28
+
29
+ - `brasskey doctor`: hardware, engines and running servers.
30
+ - Planning with `brasskey run --dry-run`.
31
+ - `brasskey run` with llama.cpp, MLX (Apple Silicon), vLLM or SGLang (NVIDIA on Linux, as a
32
+ process or from the official image pinned by digest). It downloads and verifies the model,
33
+ then serves it on 127.0.0.1 through a Brasskey proxy that enforces API keys. Ctrl-C stops it
34
+ cleanly. llama.cpp and MLX are tested on real hardware; vLLM and SGLang are not yet tested on
35
+ real GPUs.
36
+ - `brasskey doctor --security`: checks this machine, or a URL, for exposed model servers.
37
+ - `brasskey bench`: repeated GuideLLM runs, 95% intervals on every metric, and PASS / FAIL /
38
+ INCONCLUSIVE when comparing two setups.
39
+
40
+ Next: testing vLLM and SGLang on NVIDIA GPUs, then 0.1.0. Design decisions are recorded in
41
+ [docs/decisions](docs/decisions/).
42
+
43
+ ## Install
44
+
45
+ Python 3.11 or newer, on macOS or Linux (Windows through WSL2):
46
+
47
+ ```bash
48
+ uv tool install brasskey # or: pip install brasskey
49
+ brasskey doctor # what Brasskey sees on this machine
50
+ brasskey run --dry-run # the model it would pick for this machine, and why
51
+ ```
52
+
53
+ `brasskey run` starts an engine you have installed, for example `brew install llama.cpp`; on
54
+ Apple Silicon, Brasskey can set up MLX itself if you have uv. `brasskey doctor` shows what's
55
+ installed and how to add the rest. Releases are signed and reproducible; see
56
+ [SECURITY.md](SECURITY.md#verifying-a-release).
57
+
58
+ ## Try it from source
59
+
60
+ You need [uv](https://docs.astral.sh/uv/) 0.13.6 or newer.
61
+
62
+ ```bash
63
+ git clone https://github.com/Prcept-AI/brasskey.git
64
+ cd brasskey
65
+ uv sync
66
+ uv run brasskey --help
67
+ uv run brasskey doctor # what Brasskey sees on this machine (CPU, memory, GPUs)
68
+ uv run brasskey doctor --json
69
+ uv run brasskey run --dry-run # the model Brasskey would pick for this machine, and why
70
+ uv run brasskey run qwen3-14b --dry-run --context 32768
71
+ uv run brasskey run hf:Qwen/Qwen3-4B-GGUF:Q8_0 --dry-run # any Hugging Face repo
72
+
73
+ brew install llama.cpp # the engine (macOS or Linux)
74
+ uv run brasskey run qwen3-0.6b # download (639 MB), start, serve; Ctrl-C stops it
75
+ uv run brasskey run qwen3-4b --save # also writes brasskey.yaml + brasskey.lock
76
+ uv run brasskey run --engine mlx # Apple Silicon: MLX via uv, set up on first use
77
+ uv run brasskey run --engine vllm # NVIDIA on Linux: vLLM on PATH, or its pinned image
78
+
79
+ uv run brasskey bench http://127.0.0.1:8000/v1 --save base.json # measure a server
80
+ uv run brasskey bench http://127.0.0.1:8001/v1 --baseline base.json # PASS / FAIL / INCONCLUSIVE
81
+ uv run brasskey bench http://127.0.0.1:8001/v1 --compare http://127.0.0.1:8000/v1
82
+
83
+ uv run brasskey doctor --security # exposed model servers, keys, Docker, firewall
84
+ uv run brasskey doctor --security http://gpu-box:8000/v1 # check a server you run elsewhere
85
+ uv run brasskey run qwen3-4b --host 0.0.0.0 --generate-api-key # reachable from your network
86
+ ```
87
+
88
+ Every command supports `--json` (one JSON document on stdout), `--debug` (logs and full
89
+ tracebacks on stderr) and `--yes` (skip confirmations), and ends with a `Next:` suggestion.
90
+
91
+ ## Secure and private by default
92
+
93
+ Servers bind to `127.0.0.1`. Any other address requires a strong API key (from
94
+ `BRASSKEY_API_KEY` or your OS keychain, never a command-line argument). There is no telemetry,
95
+ and prompt content is never logged. See [SECURITY.md](SECURITY.md).
96
+
97
+ ## Contributing
98
+
99
+ See [CONTRIBUTING.md](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).
100
+
101
+ ## License and pledge
102
+
103
+ Apache-2.0 (see [LICENSE](LICENSE) and [NOTICE](NOTICE)). **The Brasskey core is Apache 2.0 and
104
+ stays Apache 2.0.** Paid features for organizations live in separate repositories and never
105
+ change the license of this one. The Brasskey name and logo are trademarks of Prcept AI LLP; see
106
+ [TRADEMARKS.md](TRADEMARKS.md).
107
+
108
+ Made by Prcept AI LLP.