soundings-cli 0.0.0-stage → 0.2.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,124 @@
1
+ # Soundings licensing
2
+
3
+ Copyright 2026 Dynamo Maritime Ltd.
4
+
5
+ Soundings is source-available. It is not open source in the OSI sense. Two licences apply:
6
+
7
+ | Part | Licence |
8
+ | --- | --- |
9
+ | Everything in this repository and package **except** the paid features listed in `LICENSE-COMMERCIAL.md` | Functional Source License 1.1, Apache 2.0 future licence (`FSL-1.1-ALv2`), below |
10
+ | The paid features: the files and folders listed in section 1 of [`LICENSE-COMMERCIAL.md`](LICENSE-COMMERCIAL.md), and the parts of `dist/` compiled from them | Soundings Commercial Licence, in [`LICENSE-COMMERCIAL.md`](LICENSE-COMMERCIAL.md) | Soundings Commercial Licence, in [`LICENSE-COMMERCIAL.md`](LICENSE-COMMERCIAL.md) |
11
+
12
+ In plain terms, and not replacing either licence:
13
+
14
+ - You can use the scanner free of charge for any purpose except offering a competing product or service. That includes at work, on client projects and in CI.
15
+ - Each release also becomes available under the Apache License 2.0 two years after it is published.
16
+ - The paid features need a valid licence key for a plan that includes them. You may not remove, disable or get around the licence check.
17
+
18
+ ---
19
+
20
+ # Functional Source License, Version 1.1, ALv2 Future License
21
+
22
+ ## Abbreviation
23
+
24
+ FSL-1.1-ALv2
25
+
26
+ ## Notice
27
+
28
+ Copyright 2026 Dynamo Maritime Ltd
29
+
30
+ ## Terms and Conditions
31
+
32
+ ### Licensor ("We")
33
+
34
+ The party offering the Software under these Terms and Conditions.
35
+
36
+ ### The Software
37
+
38
+ The "Software" is each version of the software that we make available under
39
+ these Terms and Conditions, as indicated by our inclusion of these Terms and
40
+ Conditions with the Software.
41
+
42
+ ### License Grant
43
+
44
+ Subject to your compliance with this License Grant and the Patents,
45
+ Redistribution and Trademark clauses below, we hereby grant you the right to
46
+ use, copy, modify, create derivative works, publicly perform, publicly display
47
+ and redistribute the Software for any Permitted Purpose identified below.
48
+
49
+ ### Permitted Purpose
50
+
51
+ A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
52
+ means making the Software available to others in a commercial product or
53
+ service that:
54
+
55
+ 1. substitutes for the Software;
56
+
57
+ 2. substitutes for any other product or service we offer using the Software
58
+ that exists as of the date we make the Software available; or
59
+
60
+ 3. offers the same or substantially similar functionality as the Software.
61
+
62
+ Permitted Purposes specifically include using the Software:
63
+
64
+ 1. for your internal use and access;
65
+
66
+ 2. for non-commercial education;
67
+
68
+ 3. for non-commercial research; and
69
+
70
+ 4. in connection with professional services that you provide to a licensee
71
+ using the Software in accordance with these Terms and Conditions.
72
+
73
+ ### Patents
74
+
75
+ To the extent your use for a Permitted Purpose would necessarily infringe our
76
+ patents, the license grant above includes a license under our patents. If you
77
+ make a claim against any party that the Software infringes or contributes to
78
+ the infringement of any patent, then your patent license to the Software ends
79
+ immediately.
80
+
81
+ ### Redistribution
82
+
83
+ The Terms and Conditions apply to all copies, modifications and derivatives of
84
+ the Software.
85
+
86
+ If you redistribute any copies, modifications or derivatives of the Software,
87
+ you must include a copy of or a link to these Terms and Conditions and not
88
+ remove any copyright notices provided in or with the Software.
89
+
90
+ ### Disclaimer
91
+
92
+ THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
93
+ IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
94
+ PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
95
+
96
+ IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
97
+ SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
98
+ EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
99
+
100
+ ### Trademarks
101
+
102
+ Except for displaying the License Details and identifying us as the origin of
103
+ the Software, you have no right under these Terms and Conditions to use our
104
+ trademarks, trade names, service marks or product names.
105
+
106
+ ## Grant of Future License
107
+
108
+ We hereby irrevocably grant you an additional license to use the Software under
109
+ the Apache License, Version 2.0 that is effective on the second anniversary of
110
+ the date we make the Software available. On or after that date, you may use the
111
+ Software under the Apache License, Version 2.0, in which case the following
112
+ will apply:
113
+
114
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
115
+ this file except in compliance with the License.
116
+
117
+ You may obtain a copy of the License at
118
+
119
+ http://www.apache.org/licenses/LICENSE-2.0
120
+
121
+ Unless required by applicable law or agreed to in writing, software distributed
122
+ under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
123
+ CONDITIONS OF ANY KIND, either express or implied. See the License for the
124
+ specific language governing permissions and limitations under the License.
@@ -0,0 +1,63 @@
1
+ # Soundings Commercial Licence
2
+
3
+ Copyright 2026 Dynamo Maritime Ltd, registered in England and Wales, company number 17152743 ("we", "us").
4
+
5
+ ## 1. What this licence covers
6
+
7
+ "Paid Features" means the source code of these files and folders of Soundings, and that code in any compiled or bundled form, including the parts of `dist/` built from it:
8
+
9
+ - `src/documents/build.ts`;
10
+ - the `src/import/` folder;
11
+ - these files in `src/export/`: `docx.ts`, `footnotes.ts`, `html.ts`, `markdown-model.ts`, `questionnaire.ts`, `render.ts` and `zip.ts`; and
12
+ - the parts of `src/cli/main.ts` that run the `answers`, `answer` and `document` commands and the `html` and `docx` export formats.
13
+
14
+ Everything else in Soundings is licensed separately under the Functional Source License (see `LICENSE`). That includes the scanner, the question flow, the `verify` command, the fixed wording in `src/export/notice.ts` and `src/documents/templates.ts`, and the licence check itself (which section 4 still protects). If a file is added to the list above in a later release, the change is recorded in `CHANGELOG.md`.
15
+
16
+ "Licence Key" means a key issued by us, or by a reseller acting for us, when you buy a Soundings plan (for example Pro or Agency). "Plan" means the plan the Licence Key was issued for, together with its limits, such as the number of machines.
17
+
18
+ ## 2. What you may do with a Licence Key
19
+
20
+ While you hold a valid, active Licence Key, we grant you a non-exclusive, non-transferable right to use the Paid Features that your Plan includes:
21
+
22
+ - on no more machines than your Plan allows; and
23
+ - for your own work, including producing reports for your own clients.
24
+
25
+ ## 3. What you may do without a Licence Key
26
+
27
+ You may install, copy and redistribute the unmodified Soundings package that contains the Paid Features, for example through npm, package mirrors or caches. You may also read the source code. You may not use the Paid Features without a Licence Key.
28
+
29
+ ## 4. What you may not do
30
+
31
+ You may not:
32
+
33
+ 1. remove, disable, modify or get around the licence check, the entitlement code or any limit of your Plan, or use a modified copy of Soundings to reach Paid Features your Plan does not include;
34
+ 2. share a Licence Key beyond your Plan's limits, or sell, rent or transfer it;
35
+ 3. modify the Paid Features or create derivative works of them;
36
+ 4. sublicense, sell or redistribute the Paid Features apart from the unmodified Soundings package; or
37
+ 5. use the Paid Features, or their source code, to build or provide a product or service that competes with Soundings.
38
+
39
+ Nothing in this licence limits any right you have by law that cannot be excluded by contract.
40
+
41
+ ## 5. Your output
42
+
43
+ Reports, history files and other output you produce with the Paid Features belong to you. We claim no rights in them, and we never receive your code.
44
+
45
+ ## 6. When the licence ends
46
+
47
+ Your rights under this licence end when your Licence Key expires or is revoked, for example when your subscription ends, or if you break this licence. You must then stop using the Paid Features. Output you have already produced stays yours, and the rest of Soundings keeps working under its own licence.
48
+
49
+ ## 7. No warranty, and limits on liability
50
+
51
+ The Paid Features are provided "as is". They produce automated scan results and draft documents. They are not legal advice, a compliance certification or a guarantee, and no tool finds every problem.
52
+
53
+ As far as the law allows, we are not liable for any indirect or consequential loss, or for any loss of profits, revenue, data or goodwill. Our total liability to you under or in connection with this licence is limited to the amount you paid for your Licence Key in the 12 months before the claim.
54
+
55
+ Nothing in this licence limits or excludes liability for death or personal injury caused by negligence, for fraud, or for anything else that cannot be limited or excluded by law. If you are a consumer, your statutory rights are not affected.
56
+
57
+ ## 8. Purchase terms
58
+
59
+ Prices, billing, renewals and refunds are covered by the terms you accept at checkout, not by this licence.
60
+
61
+ ## 9. Law
62
+
63
+ This licence is governed by the law of England and Wales, and the courts of England and Wales have exclusive jurisdiction.
package/README.md CHANGED
@@ -1,3 +1,71 @@
1
- # Temporary Holding Version
1
+ # Soundings
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ **Evidence-backed answers to security questionnaires, run locally.**
4
+
5
+ Soundings scans a project on your own machine and records what it finds: which AI providers it calls, where data is stored and sent, how users sign in, how keys are handled. Answers to a client's security questionnaire are then built from those findings, and anything the code can't tell it becomes a question for you. Your code never leaves your machine.
6
+
7
+ Status: 0.2.0. Scanning, questions, answers, questionnaire import, verification, licensing, the five documents and the exports work. Available on npm as `soundings-cli`.
8
+
9
+ ```
10
+ soundings scan . # what does the code show?
11
+ soundings questions # ask only what it can't
12
+ soundings answers --output answers.md # 43 standard questions, every sentence sourced
13
+ soundings answer client.csv # fill in a client's questionnaire (never guesses)
14
+ soundings document privacy-notice # also: subprocessors, dpia, ai-use, trust-page
15
+ soundings verify draft.md # check any text against the evidence
16
+ ```
17
+
18
+ ```
19
+ Soundings 0.0.1 · notes-saas · nextjs, react, stripe, supabase-js
20
+ 10 files, 14 detectors, 64 ms. Your code never left this machine.
21
+
22
+ AI providers
23
+ EV-3acc7131 OpenAI [stated by the code]
24
+ The app uses the OpenAI SDK from server code.
25
+ app/api/summarise/route.ts:1
26
+ ...
27
+ Only you can answer these (3)
28
+ UQ-supabase-region In which region is the Supabase project hosted?
29
+ Hosting is set up outside the code, so a scan can't see it.
30
+ ```
31
+
32
+ ## What it does
33
+
34
+ - **Scans locally.** No network calls, no telemetry, no upload. It reads JavaScript and TypeScript projects (Next.js, Node/Express, Supabase, Firebase, Stripe and the main AI SDKs) and reports anything else as "couldn't determine".
35
+ - **Writes evidence, not code.** `soundings-evidence.json` holds file paths, line numbers and one-sentence claims. It never holds source code or secret values, and the scan fails loudly if a secret would end up in it.
36
+ - **Says how sure it is.** Each fact is stated by the code, inferred, or "not found by the scan". An empty search is never presented as proof.
37
+ - **Asks instead of guessing.** What the code can't show (a hosting region, an account setting at a provider, how long data is kept) becomes a question with a stable ID.
38
+
39
+ - **Answers a standard question bank.** 43 questions on AI use, data, access, keys, logging, suppliers and incident response. Each sentence cites a scan fact or something you said, and the document ends with numbered sources. If your answer and the scan disagree, yours wins and the document notes the difference.
40
+
41
+ - **Fills in a client's questionnaire.** Rows that clearly match a bank question are answered; everything else is marked and listed, never guessed.
42
+ - **Checks any text.** `soundings verify` fails any statement without a real source that mentions what it claims, so an AI assistant's draft can be trusted only as far as it can be checked.
43
+
44
+ Scanning, questions and verification are free and make no network calls. The answers documents and questionnaire import are Soundings Pro; see [docs/plans.md](docs/plans.md) for exactly what the one licence check sends.
45
+
46
+ - **Writes the documents.** Privacy notice, subprocessor list, impact assessment draft, AI-use statement and trust page, as Markdown, a self-contained HTML page (print it for a PDF) or a Word file with real footnotes. Anything the code and your answers can't say is listed as needing your input, never filled in.
47
+
48
+ See [docs/documents.md](docs/documents.md), [docs/questions.md](docs/questions.md), [docs/questionnaires.md](docs/questionnaires.md), [docs/verify.md](docs/verify.md), [docs/detectors.md](docs/detectors.md) for what each detector reads and where it stops, and [docs/evidence-format.md](docs/evidence-format.md) for the file format.
49
+
50
+ ## Options
51
+
52
+ ```
53
+ soundings [scan] [path] Scan a project (default: current folder)
54
+ soundings questions Ask only what the code can't answer (--list, --set key=value)
55
+ soundings answers Answer the question bank (--output, --format markdown|json, --no-locations)
56
+ --output <file> Where to save the evidence (default: ./soundings-evidence.json)
57
+ --no-write Print the report but don't save the file
58
+ --format terminal|json Report format
59
+ --seaworthy <file> Include findings from a Seaworthy JSON report
60
+ --config <file> Config file (default: <path>/soundings.config.json)
61
+ soundings answer <file.csv> Fill in a client questionnaire (CSV) Pro
62
+ soundings document <type> Privacy notice, subprocessors, dpia, ai-use, trust-page Pro
63
+ soundings buy | login <key> | logout | status Plans and licence
64
+ soundings verify <file> Check text against the evidence (--strict, --format json)
65
+ ```
66
+
67
+ Soundings produces drafts. It is not legal advice and does not say that anyone is compliant with anything.
68
+
69
+ ## Licence
70
+
71
+ Source-available. See [LICENSE](LICENSE) and [LICENSE-COMMERCIAL.md](LICENSE-COMMERCIAL.md).