bootproof 0.1.0

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.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Bootproof contributors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,265 @@
1
+ # BootProof
2
+
3
+ > **The honest Run Button for repos — with proof, not vibes.**
4
+
5
+ **Human diagnosis. Machine proof. One engine.**
6
+
7
+ <p align="center">
8
+ <img src="https://raw.githubusercontent.com/rossbuckley1990-hash/bootproof/main/assets/bootproof_viral_demo.gif" alt="BootProof demo" width="900">
9
+ </p>
10
+
11
+ BootProof inspects a local repository, builds an evidence-based run plan, executes only what it can justify, observes HTTP health, and writes a signed attestation for success or failure.
12
+
13
+ It does not turn every repository green. That would defeat the point.
14
+
15
+ ```text
16
+ No proof, no green check.
17
+ ```
18
+
19
+ ## One engine. Two interfaces.
20
+
21
+ Humans run:
22
+
23
+ ```bash
24
+ bootproof up .
25
+ ```
26
+
27
+ They get a diagnosis and a runbook.
28
+
29
+ Machines run:
30
+
31
+ ```bash
32
+ bootproof up . --ci --json
33
+ ```
34
+
35
+ They get a signed verdict and a deterministic exit code.
36
+
37
+ The same engine powers both.
38
+
39
+ ## What It Tells Humans
40
+
41
+ A failed run is still useful:
42
+
43
+ ```text
44
+ NOT VERIFIED — package_manager_version_mismatch
45
+ What happened: The repository requires pnpm 10.24.0, but this environment has pnpm 9.15.4.
46
+ Why BootProof refused: The dependency install cannot be trusted with the wrong package manager version.
47
+ Safe next step: Run corepack enable && corepack prepare pnpm@10.24.0 --activate, then rerun BootProof.
48
+ Evidence: .bootproof/attestation.json
49
+ ```
50
+
51
+ BootProof distinguishes diagnosis from proof. Detecting Python, Flask, React, Celery, Go, or a monorepo does not mean BootProof claims full orchestration support for that stack.
52
+
53
+ ## What It Gives Machines
54
+
55
+ `--json` emits exactly one `bootproof/result/v1` object to stdout:
56
+
57
+ ```json
58
+ {
59
+ "schema": "bootproof/result/v1",
60
+ "booted": false,
61
+ "healthVerified": false,
62
+ "failureClass": "dependency_install_skipped",
63
+ "attestationPath": ".bootproof/attestation.json",
64
+ "inference": {},
65
+ "plan": {},
66
+ "observed": []
67
+ }
68
+ ```
69
+
70
+ `--ci` disables colour and interactive output. Exit codes are deterministic:
71
+
72
+ - `0`: `booted === true` and `healthVerified === true`
73
+ - `1`: every refusal, ambiguity, install failure, service failure, app failure, or health failure
74
+
75
+ ## Quick Start
76
+
77
+ Run against a local repository:
78
+
79
+ ```bash
80
+ cd /path/to/repository
81
+ npx bootproof up .
82
+ ```
83
+
84
+ Host execution can be selected explicitly:
85
+
86
+ ```bash
87
+ npx bootproof up . --provider local --unsafe-local
88
+ ```
89
+
90
+ Run dependency installation only when intended:
91
+
92
+ ```bash
93
+ npx bootproof up . --install
94
+ ```
95
+
96
+ Explain and verify the signed result:
97
+
98
+ ```bash
99
+ npx bootproof explain .bootproof/attestation.json
100
+ npx bootproof verify .bootproof/attestation.json
101
+ ```
102
+
103
+ Run against a public GitHub repository:
104
+
105
+ ```bash
106
+ npx bootproof up https://github.com/user/repo
107
+ ```
108
+
109
+ BootProof clones credential-free HTTPS GitHub URLs into `.bootproof/remotes/` and retains the clone so its evidence and any generated files continue to exist. It inspects the clone but refuses to execute remote code until host execution is explicitly acknowledged:
110
+
111
+ ```bash
112
+ npx bootproof up https://github.com/user/repo --provider local --unsafe-local
113
+ ```
114
+
115
+ Review the inferred commands before using that acknowledgement. Add `--install` only when you also intend to run dependency installation and its lifecycle scripts. Remote `--dry-run` is refused before cloning because dry runs promise to write nothing.
116
+
117
+ Contributors working from this source repository can use `npm ci`, `npm run build`, and `npm link`. Those steps are not required for npm users.
118
+
119
+ ## Honesty Contract
120
+
121
+ BootProof is constrained on purpose:
122
+
123
+ - no verified boot without an observed health signal
124
+ - no success rendering for skipped steps
125
+ - no invented secrets
126
+ - no writes to `.env`, `.env.local`, `.env.development`, or `.env.production`
127
+ - no silent project patching
128
+ - no guessed workspace when the repository is ambiguous
129
+ - no claim that generated scaffolding exists unless it was written
130
+ - signed failed attestations for refusals and execution failures
131
+ - raw local evidence preserved in the attestation
132
+ - no telemetry or hidden evidence upload
133
+
134
+ See [docs/HONESTY_CONTRACT.md](docs/HONESTY_CONTRACT.md).
135
+
136
+ ## Current Capabilities
137
+
138
+ BootProof currently provides:
139
+
140
+ - Node package-manager and start-command inference
141
+ - Python/Flask and Go/Node hybrid detection
142
+ - monorepo candidate ranking
143
+ - Docker service dependency detection and scaffolding
144
+ - localhost health-candidate discovery from repository evidence and app logs
145
+ - classified failures
146
+ - signed Ed25519 attestations
147
+ - strict JSON and fail-closed CI output
148
+ - redacted registry-entry export
149
+
150
+ Detection is broader than orchestration. For example:
151
+
152
+ - Superset-like Python/Flask/React/Celery repos are detected, then honestly refused with `python_flask_setup_required`.
153
+ - Grafana-like Go/Node hybrids are detected without pretending a frontend watcher is the whole application.
154
+ - Parallel monorepo root commands are refused until a specific workspace is selected.
155
+
156
+ ## Files Written
157
+
158
+ Depending on the observed plan, BootProof may write:
159
+
160
+ ```text
161
+ .bootproof/attestation.json
162
+ .bootproof/registry-entry.json
163
+ docker-compose.bootproof.yml
164
+ .env.bootproof.example
165
+ ```
166
+
167
+ `registry-entry.json` is written only by `bootproof attest export`.
168
+
169
+ Docker and env guidance files are listed in proof only when BootProof actually generated them.
170
+
171
+ Protected application env files remain untouched.
172
+
173
+ ## Attestation Trust
174
+
175
+ Current attestations contain:
176
+
177
+ ```json
178
+ {
179
+ "trust": {
180
+ "level": "local_developer_signed",
181
+ "signer": "local_ed25519",
182
+ "oidc": null
183
+ }
184
+ }
185
+ ```
186
+
187
+ Local attestations are useful evidence. CI/OIDC attestations are stronger supply-chain proof. BootProof does not pretend local laptop proof is enterprise CI proof.
188
+
189
+ The future `ci_oidc_signed` level is reserved but is not emitted today.
190
+
191
+ ## Failure Taxonomy
192
+
193
+ Examples include:
194
+
195
+ - `not_an_application`
196
+ - `workspace_ambiguous`
197
+ - `dependency_install_skipped`
198
+ - `package_manager_version_mismatch`
199
+ - `python_flask_setup_required`
200
+ - `service_port_allocated`
201
+ - `postgres_auth_env_missing`
202
+ - `health_http_error`
203
+ - `health_check_timeout`
204
+ - `unknown_failure`
205
+
206
+ Unknown failures remain unknown, with evidence preserved for the next detector.
207
+
208
+ See [docs/FAILURE_TAXONOMY.md](docs/FAILURE_TAXONOMY.md).
209
+
210
+ ## Real Repository Evidence
211
+
212
+ BootProof records both useful successes and useful failures. The evidence ledger does not relabel failure as support.
213
+
214
+ See [docs/REAL_REPO_EVIDENCE.md](docs/REAL_REPO_EVIDENCE.md).
215
+
216
+ ## CI And Registry
217
+
218
+ BootProof does not upload attestations. A project can deliberately commit `.bootproof/` or export a redacted registry entry.
219
+
220
+ The Git-native registry and OIDC-backed trust model are designs in progress, not deployed services.
221
+
222
+ - [docs/CI_ACTION.md](docs/CI_ACTION.md)
223
+ - [docs/REGISTRY.md](docs/REGISTRY.md)
224
+
225
+ ## Release Packaging
226
+
227
+ The npm package contains the compiled CLI, license, README, and docs. `dist/` is required at runtime, generated by `npm run build` during `prepack`, and intentionally not committed.
228
+
229
+ Run `npm run pack:check` to pack BootProof, install the tarball in an isolated temporary directory, and exercise the installed CLI. See [docs/RELEASE_CHECKLIST.md](docs/RELEASE_CHECKLIST.md).
230
+
231
+ ## Release Hygiene
232
+
233
+ `node_modules/`, `.DS_Store`, and generated `dist/` are ignored and not committed.
234
+
235
+ `dist/` is generated by `npm run build`. It is included in the npm package because `dist/cli.js` is the executable, and `npm pack`/publish runs the `prepack` build.
236
+
237
+ Repository metadata points to:
238
+
239
+ ```text
240
+ https://github.com/rossbuckley1990-hash/bootproof
241
+ ```
242
+
243
+ ## What BootProof Is Not
244
+
245
+ BootProof is not a deployment platform, a general CI replacement, or a magic environment fixer.
246
+
247
+ It is the honest Run Button for repos. It runs what it can, refuses what it cannot prove, signs both success and failure, and gives humans and machines the same evidence.
248
+
249
+ ## Status
250
+
251
+ BootProof is early alpha.
252
+
253
+ Near-term work includes:
254
+
255
+ - additional remote source providers beyond public HTTPS GitHub repositories
256
+ - stronger multi-service orchestration
257
+ - broader Python and Go execution support
258
+ - CI/OIDC-backed signing
259
+ - proof-linked badges and a verified public index
260
+
261
+ Unsupported paths should fail clearly, not magically.
262
+
263
+ ## License
264
+
265
+ Apache-2.0
package/dist/cli.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ export {};