@allthingsai/swapcheck 0.1.1

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,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.
package/NOTICE ADDED
@@ -0,0 +1,5 @@
1
+ Swapcheck
2
+ Copyright 2026 All Things AI, Inc.
3
+
4
+ This product is licensed under the Apache License, Version 2.0.
5
+ Its published bundle includes the yaml package (ISC license, Copyright Eemeli Aro).
package/README.md ADDED
@@ -0,0 +1,173 @@
1
+ # Swapcheck
2
+
3
+ Know when the hosted LLM model you depend on is being retired, re-routed or repriced. Find what to move to. Then test the move on your own cases before you ship it.
4
+
5
+ Swapcheck is free and open source (Apache-2.0). It runs on your machine or in your CI. Your keys and prompts never go anywhere except the model provider you choose to test.
6
+
7
+ - **Scan:** finds the model IDs your code uses and checks each one against a signed public registry of model changes.
8
+ - **Watch:** fails CI when a model you use changes inside a window you set.
9
+ - **Find:** lists replacements that keep the features your code needs.
10
+ - **Test:** runs your cases on the current model and the candidates, measures noise, and only reports a drop that reproduces on fresh samples.
11
+ - **Bump:** edits the model ID in your source and opens a pull request.
12
+
13
+ ## Quick start
14
+
15
+ ```sh
16
+ npx @allthingsai/swapcheck
17
+ ```
18
+
19
+ To keep it installed, run `npm install -g @allthingsai/swapcheck` and then use the `swapcheck` command. With Python, `uvx swapcheck` or `pip install swapcheck` gives the same tool.
20
+
21
+ Real output on a small app that calls Claude Sonnet 4.5 (registry of 2026-11-10):
22
+
23
+ ```text
24
+ Scanned 1 file. Found 1 model.
25
+ Registry: 2026-11-10 (bundled)
26
+
27
+ claude-sonnet-4-5-20250929 retires 2026-11-30, in 20 days; successor claude-sonnet-5-5
28
+ app.py:7
29
+ source: https://platform.claude.com/docs/en/about-claude/model-deprecations
30
+ parameters changed 2026-10-21
31
+ source: https://platform.claude.com/docs/en/about-claude/model-deprecations#api-parameter-deprecations
32
+
33
+ 1 of 1 model has a change in the registry.
34
+ Wrote models.lock.
35
+ ```
36
+
37
+ Scanning is free and needs no API key. It writes `models.lock`, which `swapcheck watch` checks later.
38
+
39
+ ```sh
40
+ swapcheck find claude-sonnet-4-5-20250929
41
+ ```
42
+
43
+ ```text
44
+ Replacements for claude-sonnet-4-5-20250929
45
+ Needs: 50 tokens of output
46
+
47
+ 1 claude-sonnet-5-5 provider successor $10.00/M output -33% 2026-09-28
48
+ 2 claude-sonnet-4-6 same vendor $15.00/M output 0% 2026-02-17
49
+ ...
50
+ Listed by what the registry says. Prove one on your cases with: swapcheck test --to claude-sonnet-5-5
51
+ ```
52
+
53
+ ## Test a move on your cases
54
+
55
+ Put cases in `swapcheck/cases/*.json`, or start from `swapcheck cases init`, which drafts contract checks from your code. You can also import suites from ModelBump, Modelpin, OpenTelemetry, LiteLLM or Langfuse with `swapcheck cases import`.
56
+
57
+ ```sh
58
+ export ANTHROPIC_API_KEY=...
59
+ swapcheck test --to claude-haiku-5-5,claude-sonnet-4-6 --runs 3 --max-usd 1
60
+ ```
61
+
62
+ Before it spends anything, Swapcheck prints the worst-case cost and the vendors that will see your cases. Without `--yes` on a non-interactive shell it stops there. A real run on 8 support-ticket classification cases:
63
+
64
+ ```text
65
+ Models: claude-haiku-4-5-20251001, claude-haiku-5-5, claude-sonnet-4-6
66
+ Cases: 8, 3 runs each
67
+ Maximum cost: $0.22, up to 504 calls
68
+ Vendors that will see your case content: anthropic
69
+ ...
70
+ Noise: model against itself flagged 0 cases (false-change rate 0%).
71
+
72
+ claude-haiku-5-5 No change detected
73
+ No difference beyond the measured noise was detected on the 8 cases tested. This covers only those cases.
74
+ pass rate 92% to 100%
75
+ p50 latency 529 ms to 808 ms
76
+
77
+ claude-sonnet-4-6 No change detected
78
+ pass rate 92% to 88%
79
+ p50 latency 529 ms to 925 ms
80
+
81
+ Spent $0.0074 of a $1.00 limit.
82
+ ```
83
+
84
+ Verdicts are `NO_CHANGE_DETECTED`, `CHANGED`, `REGRESSED` and `NOT_ENOUGH_EVIDENCE`. A report never calls a model safe or better. It says what was measured and lists its limits.
85
+
86
+ ### How the test decides
87
+
88
+ 1. The current model runs twice as many times as each candidate, in two halves. Comparing the halves measures how much the model differs from itself.
89
+ 2. Each case is compared with Fisher's exact test. The suite is compared with a paired permutation test and a bootstrap confidence interval.
90
+ 3. A case that looks worse is re-run on fresh samples. It only counts as a regression if the drop reproduces, with a correction for the number of cases re-run.
91
+ 4. Too many errors, a budget stop, or fewer than 6 usable cases gives `NOT_ENOUGH_EVIDENCE`, not a guess.
92
+
93
+ In simulation (`e2e/stats-calibration.test.ts`) false alarms stay between 0.5% and 2.2%, and seeded regressions are caught 93% to 100% of the time. A single case dropping by 0.6 in a 10-case suite is caught about 74% of the time. The full method is in [docs/DESIGN.md](docs/DESIGN.md).
94
+
95
+ ## GitHub Action
96
+
97
+ ```yaml
98
+ name: Model changes
99
+ on:
100
+ schedule: [{ cron: "0 8 * * 1" }]
101
+ pull_request:
102
+ permissions:
103
+ contents: read
104
+ jobs:
105
+ watch:
106
+ runs-on: ubuntu-latest
107
+ steps:
108
+ - uses: actions/checkout@v5
109
+ - uses: allthingsN/swapcheck@v1
110
+ with:
111
+ mode: watch
112
+ fail-within-days: 30
113
+ ```
114
+
115
+ Modes are `watch`, `find`, `check` (spends money, needs `max-usd` and provider keys in `env`) and `bump` (opens one pull request per model with `open-prs: true` and `GITHUB_TOKEN` in `env`). Pull requests from forks only ever get the free scan. Paid modes refuse to run on `pull_request_target`, `workflow_run`, `issue_comment` and every other trigger outside `pull_request`, `push`, `schedule`, `workflow_dispatch`, `merge_group` and `release`.
116
+
117
+ ## MCP server
118
+
119
+ Swapcheck speaks MCP over stdio, so coding agents can ask it what is changing:
120
+
121
+ ```json
122
+ { "mcpServers": { "swapcheck": { "command": "npx", "args": ["-y", "@allthingsai/swapcheck", "mcp"] } } }
123
+ ```
124
+
125
+ The free tools (`scan`, `watch`, `find`, `explain_event`) are always on. The paid `test` tool only appears when you set `SWAPCHECK_MCP_ALLOW_SPEND=1`, and it can never spend more than your config budget or `SWAPCHECK_MCP_MAX_USD`, whatever the agent asks for.
126
+
127
+ ## Python
128
+
129
+ ```sh
130
+ pip install swapcheck
131
+ ```
132
+
133
+ ```python
134
+ import swapcheck
135
+ result = swapcheck.scan(".")
136
+ ```
137
+
138
+ The wheel ships the same compiled CLI and a thin wrapper over its JSON output.
139
+
140
+ ## Providers
141
+
142
+ | Provider | Key | Notes |
143
+ | --- | --- | --- |
144
+ | OpenAI | `OPENAI_API_KEY` | `SWAPCHECK_OPENAI_BASE_URL` for any OpenAI-compatible endpoint |
145
+ | Anthropic | `ANTHROPIC_API_KEY` | `SWAPCHECK_ANTHROPIC_BASE_URL` for a gateway |
146
+ | Google Gemini | `GEMINI_API_KEY` or `GOOGLE_API_KEY` | `SWAPCHECK_GEMINI_BASE_URL` for a gateway |
147
+ | OpenRouter | `OPENROUTER_API_KEY` | Route `openrouter` |
148
+
149
+ Base URLs must be HTTPS, except on localhost. Redirects are never followed, so a key can't be carried to another host.
150
+
151
+ ## The registry
152
+
153
+ Model dates, prices and capabilities come from [swapcheck-registry](https://github.com/allthingsN/swapcheck-registry), which parses 16 provider pages and catalogs every 6 hours. Each snapshot is signed with Ed25519. Swapcheck verifies the signature with a pinned key before it parses anything, refuses a snapshot older than one it already has, and falls back to the copy bundled with the release. Every event links to its source. Corrections are welcome there.
154
+
155
+ Change notices and open test workloads live in [swapcheck-reports](https://github.com/allthingsN/swapcheck-reports). Every post there is checked against its data and signed before it is published.
156
+
157
+ ## What it does not do
158
+
159
+ - It only covers the cases you test. Behavior on anything else is not measured.
160
+ - API replay can't see changes in a consumer product or an agent harness around the model.
161
+ - The scanner reads JavaScript, TypeScript, Python and common config formats. It does not read shell scripts or other languages, and a model ID built at runtime is listed as unresolved rather than guessed.
162
+
163
+ ## Security and privacy
164
+
165
+ No telemetry. The only network calls are the registry fetch, the providers you choose to test, and the GitHub API during `bump --open-pr`. Tool calls a model asks for are recorded and mocked, never run. See [SECURITY.md](SECURITY.md) for the full model and how to report a vulnerability.
166
+
167
+ ## Contributing
168
+
169
+ See [CONTRIBUTING.md](CONTRIBUTING.md). Tests need no network and no keys: `npm ci && npm test && npm run e2e`.
170
+
171
+ ## License
172
+
173
+ Code: Apache-2.0. Registry data: CC BY 4.0. Built by [All Things AI](https://allthingsn.com).