@caspee/brain-audit 0.0.0 → 0.3.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 +52 -0
- package/README.md +277 -1
- package/THIRD-PARTY-NOTICES.md +185 -0
- package/assets/banner.svg +23 -0
- package/assets/flow.svg +55 -0
- package/dist/brain-audit.mjs +16396 -0
- package/package.json +40 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
Caspee Brain Audit CLI Licence
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 OneType P.S.A. All rights reserved.
|
|
4
|
+
|
|
5
|
+
The licensor is OneType P.S.A., Aleja Jana Pawła II 68/19, 00-170 Warsaw,
|
|
6
|
+
Poland, KRS 0001224271 ("the Licensor"), the provider of Caspee by Unabyss.
|
|
7
|
+
|
|
8
|
+
This licence covers the software "@caspee/brain-audit" (the command-line program, its
|
|
9
|
+
bundled file and the source code published with it, together "the Software").
|
|
10
|
+
|
|
11
|
+
1. Use. You may install and run the Software, without charge, to audit content that you own
|
|
12
|
+
or are allowed to audit, for yourself or for the organisation you work for. You may read
|
|
13
|
+
the source code to check what the Software does, and you may download or clone it and build
|
|
14
|
+
it, unchanged, to check that it matches the published package, and run that build under
|
|
15
|
+
this clause. Nothing in this licence limits what Article 75(2) of the Polish Copyright Act
|
|
16
|
+
allows a lawful user.
|
|
17
|
+
|
|
18
|
+
2. Restrictions. You may not:
|
|
19
|
+
a. modify, adapt, translate or create derivative works of the Software;
|
|
20
|
+
b. copy, publish, distribute, sublicense, sell, rent or otherwise make the Software, or any
|
|
21
|
+
part of it, available to others, except by pointing them to the official source
|
|
22
|
+
(the npm package @caspee/brain-audit or the repository github.com/caspee-ai/brain-audit),
|
|
23
|
+
and except an internal cache or mirror of the unchanged package within your
|
|
24
|
+
organisation.
|
|
25
|
+
This licence does not limit the rights that GitHub's Terms of Service give to users of
|
|
26
|
+
a public repository, such as viewing and forking it on GitHub;
|
|
27
|
+
c. use the Software, or any part of it, to build, train, improve or offer a product or
|
|
28
|
+
service that audits, scores, builds or hosts knowledge bases for other parties;
|
|
29
|
+
d. remove or change this licence or any copyright notice.
|
|
30
|
+
|
|
31
|
+
3. Third-party code. Parts of the Software are open-source packages under their own licences
|
|
32
|
+
(for example graphology, under the MIT licence). Those parts remain under their own terms,
|
|
33
|
+
and nothing in this licence limits them.
|
|
34
|
+
|
|
35
|
+
4. No warranty. The Software is provided "as is", without warranty of any kind, express or
|
|
36
|
+
implied, including the warranties of merchantability, fitness for a particular purpose and
|
|
37
|
+
non-infringement.
|
|
38
|
+
|
|
39
|
+
5. No liability. To the fullest extent the law allows, the Licensor is not liable for any claim,
|
|
40
|
+
damage or other loss, of any kind, arising from the Software or its use.
|
|
41
|
+
|
|
42
|
+
Nothing in clauses 4 and 5 limits the rights that a consumer, or a sole trader who has a
|
|
43
|
+
consumer's protection, has under mandatory law.
|
|
44
|
+
|
|
45
|
+
6. Ending. This licence ends automatically if you break its terms. When it ends you must stop
|
|
46
|
+
using the Software and delete your copies.
|
|
47
|
+
|
|
48
|
+
7. Law and courts. This licence is governed by Polish law. A dispute between businesses goes
|
|
49
|
+
to the courts of Warsaw. Nothing in this clause or in this licence limits the mandatory
|
|
50
|
+
rights a consumer has under the law of the country where they live.
|
|
51
|
+
|
|
52
|
+
Any right not expressly granted here is reserved by the Licensor.
|
package/README.md
CHANGED
|
@@ -1 +1,277 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="assets/banner.svg" alt="Caspee Brain Audit" width="100%">
|
|
4
|
+
|
|
5
|
+
<p>
|
|
6
|
+
<a href="https://www.npmjs.com/package/@caspee/brain-audit"><img src="https://img.shields.io/npm/v/@caspee/brain-audit?style=flat-square&color=f5c400&labelColor=3d2a00&label=npm" alt="npm version"></a>
|
|
7
|
+
<img src="https://img.shields.io/badge/node-%E2%89%A520-3d2a00?style=flat-square" alt="Node.js 20 or later">
|
|
8
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/licence-proprietary%2C%20free%20to%20run-3d2a00?style=flat-square" alt="Licence: proprietary, free to run"></a>
|
|
9
|
+
<a href="https://audit.caspee.ai"><img src="https://img.shields.io/badge/run%20it-audit.caspee.ai-f5c400?style=flat-square&labelColor=3d2a00" alt="audit.caspee.ai"></a>
|
|
10
|
+
<a href="https://caspee.ai"><img src="https://img.shields.io/badge/by-Caspee-f5c400?style=flat-square&labelColor=3d2a00" alt="Caspee"></a>
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
**Find out what your AI agents actually know: a free audit of your company brain, run on your own machine.**
|
|
14
|
+
|
|
15
|
+
[Why](#why-audit-a-brain) · [What you get](#what-you-get) · [Quickstart](#quickstart) · [How it works](#how-it-works) · [Privacy](#privacy) · [Commands](#commands) · [Licence](#licence)
|
|
16
|
+
|
|
17
|
+
</div>
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Why audit a brain
|
|
22
|
+
|
|
23
|
+
Teams now keep a "brain" for their AI agents: a folder of Markdown or text that holds what the
|
|
24
|
+
company, or one person, knows. Agents answer from it, so its quality is your agents' quality.
|
|
25
|
+
|
|
26
|
+
Brains rot quietly. Pages get duplicated, go stale, lose their links or never get written, and
|
|
27
|
+
nothing fails loudly: the agent just answers from what is there, wrong or missing. Nobody
|
|
28
|
+
measures it, so nobody sees it.
|
|
29
|
+
|
|
30
|
+
The Caspee Brain Audit measures it. Your own agent runs this CLI on your folder and you get a
|
|
31
|
+
score, a map and the fixes that matter most. No file content reaches Caspee: to grade merit,
|
|
32
|
+
your agent reads some of your files, under the terms you have with its AI provider.
|
|
33
|
+
|
|
34
|
+
## What you get
|
|
35
|
+
|
|
36
|
+
A private report with two audits and what to do about them:
|
|
37
|
+
|
|
38
|
+
| Part | What it shows |
|
|
39
|
+
| --------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
40
|
+
| **Structural audit** | Dead, ambiguous and outside links, orphans, dead ends, undated and stale pages, uncited evidence. |
|
|
41
|
+
| **Merit audit** | Does the brain cover what a business like yours needs to know? Graded by your agent against a rubric. |
|
|
42
|
+
| **Tree** | Your brain's folders and files as one browsable map, each file with its own findings. |
|
|
43
|
+
| **Constellation** | Every page as a star and every link as a line: the clusters, the bridges and what floats alone. |
|
|
44
|
+
| **Summary and score** | One score out of 100 from structure and merit, with the measures behind it. |
|
|
45
|
+
| **Top 5 fixes** | The five changes that matter most, each with how to fix it by hand, then the full list file by file. |
|
|
46
|
+
|
|
47
|
+
It reads any folder of Markdown or text: a company brain, a docs repo, an Obsidian or Logseq
|
|
48
|
+
vault, a Markdown export of a wiki.
|
|
49
|
+
|
|
50
|
+
## Quickstart
|
|
51
|
+
|
|
52
|
+
You need Claude Code, Codex or Cursor, Node.js 20 or newer, and an email address you can read.
|
|
53
|
+
|
|
54
|
+
**1. Connect your agent** to the audit's MCP server, `https://audit.caspee.ai/mcp`:
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
# Claude Code
|
|
58
|
+
claude mcp add --transport http --scope user brain-audit https://audit.caspee.ai/mcp
|
|
59
|
+
|
|
60
|
+
# Codex
|
|
61
|
+
codex mcp add brain-audit --url https://audit.caspee.ai/mcp
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Cursor: add this to `~/.cursor/mcp.json` (every project) or `.cursor/mcp.json` (one project):
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{ "mcpServers": { "brain-audit": { "url": "https://audit.caspee.ai/mcp" } } }
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
**2. Ask your agent:**
|
|
71
|
+
|
|
72
|
+
> Run the Caspee brain audit on my brain folder.
|
|
73
|
+
|
|
74
|
+
The MCP tells your agent each step: it confirms your email with a 6-digit code, runs
|
|
75
|
+
`npx @caspee/brain-audit` on your folder, confirms your company type with you, asks three
|
|
76
|
+
short optional questions, grades merit and hands you the report link. [audit.caspee.ai](https://audit.caspee.ai) has the same setup
|
|
77
|
+
for each agent, plus a small skill or rule that keeps the agent on the audit's steps.
|
|
78
|
+
|
|
79
|
+
The audit is free. In return, OneType P.S.A. (Caspee) contacts you by email about your result
|
|
80
|
+
and about Caspee; you can stop that at any time. See the
|
|
81
|
+
[privacy policy](https://audit.caspee.ai/privacy).
|
|
82
|
+
|
|
83
|
+
## How it works
|
|
84
|
+
|
|
85
|
+
<p align="center"><img src="assets/flow.svg" alt="Your agent runs the CLI on your machine; the CLI sends only numbers and a sealed report to audit.caspee.ai; the key is never uploaded" width="100%"></p>
|
|
86
|
+
|
|
87
|
+
| Step | Where | What crosses the network |
|
|
88
|
+
| ----------- | ------------ | --------------------------------------------------------------------------- |
|
|
89
|
+
| `extract` | your machine | one download of the audit's method; the audit id, its token, CLI version |
|
|
90
|
+
| feedback | your agent | only the answers you choose to give, and the agent's guess of your setup |
|
|
91
|
+
| grading | your agent | nothing from this CLI |
|
|
92
|
+
| `finish` | your machine | one upload: a plain summary of numbers and a report sealed with AES-256-GCM |
|
|
93
|
+
| open report | your browser | the link, without the key: the part after `#k=` is never sent to a server |
|
|
94
|
+
|
|
95
|
+
In short: **it runs locally, the CLI sends only numbers in readable form, and every name
|
|
96
|
+
travels sealed under a key made on your machine and never uploaded.** Before the report link,
|
|
97
|
+
your agent may also send the answers you choose to give to three optional questions, and its
|
|
98
|
+
guess of how your brain is served to agents. The details follow.
|
|
99
|
+
|
|
100
|
+
## Running the CLI by hand
|
|
101
|
+
|
|
102
|
+
Your agent does this for you, guided by the MCP; every step is here so you can read it.
|
|
103
|
+
Requires Node.js 20 or later. No install: `npx @caspee/brain-audit@<version> …`.
|
|
104
|
+
|
|
105
|
+
```sh
|
|
106
|
+
# 0. The audit token, in the environment rather than on the command line.
|
|
107
|
+
export BRAIN_AUDIT_TOKEN=<audit_token>
|
|
108
|
+
|
|
109
|
+
# 1. Download the audit's method (one request), then read the folder and measure it.
|
|
110
|
+
# Nothing of the folder leaves this machine.
|
|
111
|
+
npx @caspee/brain-audit extract ./my-brain --audit <audit_id> --company-type tech
|
|
112
|
+
|
|
113
|
+
# 2. Your agent grades the merit pack it wrote (~/.caspee/brain-audit/<audit_id>/merit-pack.json)
|
|
114
|
+
# into a grades file, using the rubric the audit MCP gives it.
|
|
115
|
+
|
|
116
|
+
# 3. Check the grades, seal the report, upload it, print your link.
|
|
117
|
+
npx @caspee/brain-audit finish --audit <audit_id> --grades grades.json
|
|
118
|
+
|
|
119
|
+
# 4. Whenever you like: remove the audit's files from this machine (keep the link first).
|
|
120
|
+
npx @caspee/brain-audit clean --audit <audit_id>
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
**The audit server.** `--api` defaults to `https://audit.caspee.ai`. The CLI accepts, without
|
|
124
|
+
another flag, only `https://audit.caspee.ai`, `https://audit.unabyss.com` (the audit's former
|
|
125
|
+
address) and `localhost`, `127.0.0.1` or `[::1]` (over http or https, for a server you run on
|
|
126
|
+
this machine). These are exact hosts: no other name under those domains is accepted. Any other
|
|
127
|
+
host is refused before any request is made (exit 2), unless you add `--unsafe-api-host`: then
|
|
128
|
+
the CLI warns on stderr, naming the host, and its JSON says `"api_trusted": false`. Use it only
|
|
129
|
+
for an audit server you run yourself: the token and the sealed report go to that host. The CLI
|
|
130
|
+
follows no redirect.
|
|
131
|
+
|
|
132
|
+
**The audit token.** `extract` and `finish` read it from, in order, `--token <audit_token>`,
|
|
133
|
+
the environment variable `BRAIN_AUDIT_TOKEN`, or `--token-file <path>` (its first line). Use
|
|
134
|
+
the environment variable or the file: a value given with `--token` can be seen by other
|
|
135
|
+
programs on this machine and stays in your shell's history. The CLI never prints the token.
|
|
136
|
+
|
|
137
|
+
`extract` first downloads the audit's method — the catalogue of business elements, the rubric,
|
|
138
|
+
the weights and the conventions the measures follow — with one request to `--api`, checks it
|
|
139
|
+
against its content hash and keeps it in the audit's work directory; a second `extract`, and
|
|
140
|
+
`finish`, use that copy. It then runs the same structural audit Caspee runs on a brain brought to the platform
|
|
141
|
+
(links, structure, metadata, dating; one score 0–100) and builds the list of business elements
|
|
142
|
+
to grade (the merit pack: file paths, titles, headings, tags and counts, never page bodies). Without
|
|
143
|
+
`--company-type` it measures only; run it again with the type once you have confirmed it.
|
|
144
|
+
|
|
145
|
+
`finish` checks the agent's grades against the pack (and prints every problem so the agent can
|
|
146
|
+
fix them), scores merit, and builds two things:
|
|
147
|
+
|
|
148
|
+
- **the plain summary**: scores, counts and fixed category words only (for example "files: 412,
|
|
149
|
+
orphan pages: 37, structural score: 61, company type: tech, format: obsidian");
|
|
150
|
+
- **the sealed report**: everything that names something — paths, titles, tags, links, folder
|
|
151
|
+
names, the files behind each finding, the agent's grades and reasons — encrypted with
|
|
152
|
+
AES-256-GCM under a new random key made on this machine.
|
|
153
|
+
|
|
154
|
+
It uploads both, then prints the report link and saves it to
|
|
155
|
+
`~/.caspee/brain-audit/<audit_id>.url`. The key is the part of the link after `#k=`. The link
|
|
156
|
+
is built on this machine, on the `--api` origin: the CLI takes no link, path or other host from
|
|
157
|
+
the server's answer. Once the server has taken the report, running `finish` again sends nothing
|
|
158
|
+
and makes no new key: it prints and saves the same link. The same holds when the server's
|
|
159
|
+
answer was lost: once a request has gone out, `finish` sends that first report again, unchanged
|
|
160
|
+
and under the same key, even if the grades were edited since (it says so and returns
|
|
161
|
+
`grades_not_sent: true`); a report with other grades needs a new audit.
|
|
162
|
+
|
|
163
|
+
## Privacy
|
|
164
|
+
|
|
165
|
+
- **Uploaded**: the plain summary (numbers and category words) and the sealed report
|
|
166
|
+
(ciphertext). The server checks that the summary carries no path or title and stores it; it
|
|
167
|
+
cannot open the sealed report.
|
|
168
|
+
- **Optional feedback**: before grading and the report link, your agent asks how happy you are with your
|
|
169
|
+
brain (0–10), how many people use it and what they use it for. Each answer is optional;
|
|
170
|
+
"skip" sends none. Your agent sends the answers you give, and its own guess of how your
|
|
171
|
+
brain is served to agents (for example CLAUDE.md or an MCP server, from a fixed list),
|
|
172
|
+
through the audit's MCP, not through this CLI. They are kept with your contact record for 12
|
|
173
|
+
months and deleted with it.
|
|
174
|
+
- **Never uploaded**: your files, their text, any path, title, tag or name in readable form,
|
|
175
|
+
and the key. The key is kept in your report link and in your local work files; browsers do
|
|
176
|
+
not send the part after `#` to a server. To open the report, a person needs the full link and
|
|
177
|
+
must confirm an email it was shared with (yours or one you invited); keep the link like a
|
|
178
|
+
password.
|
|
179
|
+
- **Network**: `extract` downloads the audit's method (one request to `--api`,
|
|
180
|
+
`GET <api>/api/audits/<audit_id>/method`) and sends only the audit id, its token and the CLI version; `finish` makes one upload,
|
|
181
|
+
`PUT <api>/api/audits/<audit_id>`. No telemetry, no update check.
|
|
182
|
+
- **Server text**: error lines the audit server sends, and the text of the method it serves
|
|
183
|
+
(element names, the method version and hash `extract` prints, a method that does not parse),
|
|
184
|
+
are cleaned of control characters, escape sequences, bidirectional and invisible characters
|
|
185
|
+
(zero-width, tag characters), cut to a fixed length and labelled as data, not instructions:
|
|
186
|
+
`extract`'s JSON carries a `note` saying so. A failure's JSON says where its `errors` came
|
|
187
|
+
from: `"errors_from": "server"` or `"local"`.
|
|
188
|
+
- **Local files**: see the table below. Delete them with `brain-audit clean` whenever you like.
|
|
189
|
+
|
|
190
|
+
## What stays on your machine
|
|
191
|
+
|
|
192
|
+
The work directory is `~/.caspee/brain-audit/<audit_id>/`, or the folder you give with
|
|
193
|
+
`--work`. The link is saved beside it as `~/.caspee/brain-audit/<audit_id>.url`.
|
|
194
|
+
|
|
195
|
+
| File | What it holds | Written | Goes |
|
|
196
|
+
| ----------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------- |
|
|
197
|
+
| `method.json` | the audit's method, as downloaded | by `extract` | after a confirmed upload; when the method changed (`method_changed`); by `clean` |
|
|
198
|
+
| `state.json` | the measured facts of the folder | by `extract` | after a confirmed upload; on `method_changed`; by `clean` |
|
|
199
|
+
| `merit-pack.json` | the list of elements to grade (paths, titles, headings, tags, counts) | by `extract` with `--company-type` | after a confirmed upload; on `method_changed`; by `clean` |
|
|
200
|
+
| `upload.json` | until the upload is confirmed: the sealed report and its key, so a retry sends the same bytes | by `finish` | on `method_changed`; by `clean` |
|
|
201
|
+
| `upload.json` | after a confirmed upload: only the key, the report path and the plain summary, so a re-run prints the same link | rewritten by a confirmed `finish` | by `clean` |
|
|
202
|
+
| `<audit_id>.url` | the report link with its key | by a successful `finish` | by `clean` |
|
|
203
|
+
|
|
204
|
+
`brain-audit clean --audit <audit_id>` removes that audit's work directory and its `.url` file
|
|
205
|
+
(and any temporary file a write of that link left beside it). With `--work <dir>` it first checks
|
|
206
|
+
the folder is this audit's: one of `state.json`, `method.json` or `upload.json` must be a regular
|
|
207
|
+
file whose JSON names this audit id, or nothing is removed (`not_a_work_dir`, exit 3). It then
|
|
208
|
+
removes only the work files above that are regular files (and the folder, if it is then empty),
|
|
209
|
+
never anything else you keep there; it follows no link, and an entry of a work file's name that
|
|
210
|
+
is not a regular file is left and listed in `left`. `brain-audit clean --all` removes
|
|
211
|
+
`~/.caspee/brain-audit/` whole. It makes no network call and prints what it removed. The link's
|
|
212
|
+
key is kept only in these files and in the link you were given: keep the link first, or the
|
|
213
|
+
report cannot be opened again.
|
|
214
|
+
|
|
215
|
+
On macOS and Linux every file is written readable by your user only (mode `0600`, folders under
|
|
216
|
+
`~/.caspee/` `0700`), and a `--work` folder that other users can write to, or that another
|
|
217
|
+
user owns, gets a warning (through a link, the folder it points to is checked). File
|
|
218
|
+
modes do nothing on Windows: there the files rely on the access rules of your user profile.
|
|
219
|
+
|
|
220
|
+
## What it reads
|
|
221
|
+
|
|
222
|
+
Every file under the folder except `.git/`, `node_modules/`, the AI agents' own folders
|
|
223
|
+
(`.cursor/`, `.codex/`, and `.claude/` but for `.claude/skills/`, which a brain may hold) and this CLI's own
|
|
224
|
+
`~/.caspee` work directories should they lie inside it, as the platform reads a
|
|
225
|
+
repository: Markdown and plain-text pages, data files (CSV, JSON, …), up to 1 MiB per file. A
|
|
226
|
+
folder with more than 50,000 readable files is refused. Symbolic links are not followed. A `byob.yml` at the folder's root is honoured.
|
|
227
|
+
HTML exports are counted as unread (the platform converts them; this CLI does not), as are
|
|
228
|
+
files that are not UTF-8.
|
|
229
|
+
|
|
230
|
+
## Commands
|
|
231
|
+
|
|
232
|
+
| Command | Prints |
|
|
233
|
+
| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
234
|
+
| `extract <brain_dir> --audit <id> [--api <base>] [--company-type <t>] [--read-limit <n>] [--work <dir>]` | JSON: method version, counts, structural score, merit pack path, element list, `api_trusted`, `note` |
|
|
235
|
+
| `finish --audit <id> --grades <file> [--api <base>] [--work <dir>]` | JSON: scores, `report_link`, `link_file`, `api_trusted` |
|
|
236
|
+
| `clean (--audit <id> \| --all) [--work <dir>]` | JSON: `removed`, the paths it removed; `left`, entries it would not remove |
|
|
237
|
+
| `--version` | the version |
|
|
238
|
+
|
|
239
|
+
`extract` and `finish` also take `--unsafe-api-host` (another audit server, above) and the token
|
|
240
|
+
from `BRAIN_AUDIT_TOKEN`, `--token-file <path>` or `--token <t>`. A failure prints one JSON
|
|
241
|
+
object with `ok: false`, `error` and `message`; when it lists `errors`, `errors_from` says whether
|
|
242
|
+
the audit server (`"server"`) or this CLI (`"local"`) wrote them.
|
|
243
|
+
|
|
244
|
+
Company types: `general`, `tech`, `agency`, `ecommerce`, `manufacturing`, `multi-entity`,
|
|
245
|
+
`vc-backed`, `personal`. Exit codes: 0 done, 2 usage (also an `--api` host that is not
|
|
246
|
+
accepted, or no token), 3 input (folder, extract missing, pack or method changed, a `--work`
|
|
247
|
+
folder that is not this audit's for `clean`), 4 grades invalid, 5 method request or upload refused (a 426 names the
|
|
248
|
+
oldest CLI version the audit takes; `method_changed` means the audit's method changed after
|
|
249
|
+
`extract`: the stale work files are removed, run `extract` again, grade again and run `finish`;
|
|
250
|
+
`feedback_required` in `errors` means the audit's feedback step comes first: the agent calls the
|
|
251
|
+
audit's `next_step`, asks its question or records the skip, then runs `finish` again), 6 network or server failure, or rate-limited (it says when
|
|
252
|
+
to retry), 1 anything else.
|
|
253
|
+
|
|
254
|
+
`--read-limit` (files the agent may read per uncertain element) defaults to the method's own.
|
|
255
|
+
|
|
256
|
+
## Source
|
|
257
|
+
|
|
258
|
+
The readable source of everything in this package's one file — the CLI and the audit code it
|
|
259
|
+
bundles — is public at <https://github.com/caspee-ai/brain-audit>, with a build that remakes the
|
|
260
|
+
file and a test that it is the file OneType P.S.A. published. Every version on npm is published from that
|
|
261
|
+
repository by its `publish.yml` with [npm provenance](https://docs.npmjs.com/generating-provenance-statements),
|
|
262
|
+
so npm shows the commit and workflow that built it.
|
|
263
|
+
|
|
264
|
+
## Licence
|
|
265
|
+
|
|
266
|
+
Proprietary, see [LICENSE](LICENSE): you may install and run this CLI, without charge, to audit
|
|
267
|
+
content that you own or are allowed to audit, for yourself or for the organisation you work
|
|
268
|
+
for, and read, clone and build its source to check it. You may not modify or redistribute it,
|
|
269
|
+
or use it to build a product or service that audits, scores, builds or hosts knowledge bases for
|
|
270
|
+
other parties. Provided as is; Polish law. Copyright OneType P.S.A. The
|
|
271
|
+
open-source packages it contains (graphology and its helpers, MIT) keep their own licences.
|
|
272
|
+
|
|
273
|
+
## Links
|
|
274
|
+
|
|
275
|
+
- Run the audit: <https://audit.caspee.ai>
|
|
276
|
+
- Privacy policy: <https://audit.caspee.ai/privacy>
|
|
277
|
+
- Caspee: <https://caspee.ai>
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
`dist/brain-audit.mjs` contains code from these open-source packages, under their own licences.
|
|
4
|
+
|
|
5
|
+
## graphology 0.26.0 (MIT)
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
The MIT License (MIT)
|
|
9
|
+
|
|
10
|
+
Copyright (c) 2016-2021 Guillaume Plique (Yomguithereal)
|
|
11
|
+
|
|
12
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
13
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
14
|
+
in the Software without restriction, including without limitation the rights
|
|
15
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
16
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
17
|
+
furnished to do so, subject to the following conditions:
|
|
18
|
+
|
|
19
|
+
The above copyright notice and this permission notice shall be included in
|
|
20
|
+
all copies or substantial portions of the Software.
|
|
21
|
+
|
|
22
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
24
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
25
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
26
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
27
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
28
|
+
THE SOFTWARE.
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## graphology-communities-louvain 2.0.2 (MIT)
|
|
32
|
+
|
|
33
|
+
```text
|
|
34
|
+
The MIT License (MIT)
|
|
35
|
+
|
|
36
|
+
Copyright (c) 2017-2021 Guillaume Plique (Yomguithereal)
|
|
37
|
+
|
|
38
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
39
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
40
|
+
in the Software without restriction, including without limitation the rights
|
|
41
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
42
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
43
|
+
furnished to do so, subject to the following conditions:
|
|
44
|
+
|
|
45
|
+
The above copyright notice and this permission notice shall be included in
|
|
46
|
+
all copies or substantial portions of the Software.
|
|
47
|
+
|
|
48
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
49
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
50
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
51
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
52
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
53
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
54
|
+
THE SOFTWARE.
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## graphology-indices 0.17.0 (MIT)
|
|
58
|
+
|
|
59
|
+
```text
|
|
60
|
+
The MIT License (MIT)
|
|
61
|
+
|
|
62
|
+
Copyright (c) 2020-2021 Guillaume Plique (Yomguithereal)
|
|
63
|
+
|
|
64
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
65
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
66
|
+
in the Software without restriction, including without limitation the rights
|
|
67
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
68
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
69
|
+
furnished to do so, subject to the following conditions:
|
|
70
|
+
|
|
71
|
+
The above copyright notice and this permission notice shall be included in
|
|
72
|
+
all copies or substantial portions of the Software.
|
|
73
|
+
|
|
74
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
75
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
76
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
77
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
78
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
79
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
80
|
+
THE SOFTWARE.
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## graphology-utils 2.5.2 (MIT)
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
The MIT License (MIT)
|
|
87
|
+
|
|
88
|
+
Copyright (c) 2017-2021 Guillaume Plique (Yomguithereal)
|
|
89
|
+
|
|
90
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
91
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
92
|
+
in the Software without restriction, including without limitation the rights
|
|
93
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
94
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
95
|
+
furnished to do so, subject to the following conditions:
|
|
96
|
+
|
|
97
|
+
The above copyright notice and this permission notice shall be included in
|
|
98
|
+
all copies or substantial portions of the Software.
|
|
99
|
+
|
|
100
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
101
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
102
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
103
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
104
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
105
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
106
|
+
THE SOFTWARE.
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## mnemonist 0.39.8 (MIT)
|
|
110
|
+
|
|
111
|
+
```text
|
|
112
|
+
The MIT License (MIT)
|
|
113
|
+
|
|
114
|
+
Copyright (c) 2016 Guillaume Plique (Yomguithereal)
|
|
115
|
+
|
|
116
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
117
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
118
|
+
in the Software without restriction, including without limitation the rights
|
|
119
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
120
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
121
|
+
furnished to do so, subject to the following conditions:
|
|
122
|
+
|
|
123
|
+
The above copyright notice and this permission notice shall be included in
|
|
124
|
+
all copies or substantial portions of the Software.
|
|
125
|
+
|
|
126
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
127
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
128
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
129
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
130
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
131
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
132
|
+
THE SOFTWARE.
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## obliterator 2.0.5 (MIT)
|
|
136
|
+
|
|
137
|
+
```text
|
|
138
|
+
The MIT License (MIT)
|
|
139
|
+
|
|
140
|
+
Copyright (c) 2017-2021 Guillaume Plique (Yomguithereal)
|
|
141
|
+
|
|
142
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
143
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
144
|
+
in the Software without restriction, including without limitation the rights
|
|
145
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
146
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
147
|
+
furnished to do so, subject to the following conditions:
|
|
148
|
+
|
|
149
|
+
The above copyright notice and this permission notice shall be included in
|
|
150
|
+
all copies or substantial portions of the Software.
|
|
151
|
+
|
|
152
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
153
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
154
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
155
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
156
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
157
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
158
|
+
THE SOFTWARE.
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## pandemonium 2.4.1 (MIT)
|
|
162
|
+
|
|
163
|
+
```text
|
|
164
|
+
The MIT License (MIT)
|
|
165
|
+
|
|
166
|
+
Copyright (c) 2017-2020 Guillaume Plique (Yomguithereal)
|
|
167
|
+
|
|
168
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
169
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
170
|
+
in the Software without restriction, including without limitation the rights
|
|
171
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
172
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
173
|
+
furnished to do so, subject to the following conditions:
|
|
174
|
+
|
|
175
|
+
The above copyright notice and this permission notice shall be included in
|
|
176
|
+
all copies or substantial portions of the Software.
|
|
177
|
+
|
|
178
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
179
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
180
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
181
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
182
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
183
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
184
|
+
THE SOFTWARE.
|
|
185
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="1280" height="320" viewBox="0 0 1280 320" role="img" aria-labelledby="t d">
|
|
2
|
+
<title id="t">Caspee Brain Audit</title>
|
|
3
|
+
<desc id="d">Audit your company brain on your own machine. Only numbers and an encrypted report reach Caspee.</desc>
|
|
4
|
+
<defs>
|
|
5
|
+
<pattern id="dots" width="28" height="28" patternUnits="userSpaceOnUse">
|
|
6
|
+
<circle cx="2" cy="2" r="1.6" fill="#3d2a00" fill-opacity="0.10"/>
|
|
7
|
+
</pattern>
|
|
8
|
+
</defs>
|
|
9
|
+
<rect width="1280" height="320" rx="24" fill="#f5c400"/>
|
|
10
|
+
<rect width="1280" height="320" rx="24" fill="url(#dots)"/>
|
|
11
|
+
<g stroke="#3d2a00" stroke-opacity="0.22" stroke-width="2" fill="none">
|
|
12
|
+
<path d="M940 70 L1040 120 L1150 80 M1040 120 L1010 220 L1130 250 M1040 120 L1150 190 L1130 250 M1150 80 L1150 190"/>
|
|
13
|
+
</g>
|
|
14
|
+
<g fill="#3d2a00" fill-opacity="0.35">
|
|
15
|
+
<circle cx="940" cy="70" r="7"/><circle cx="1040" cy="120" r="11"/><circle cx="1150" cy="80" r="8"/>
|
|
16
|
+
<circle cx="1010" cy="220" r="8"/><circle cx="1130" cy="250" r="9"/><circle cx="1150" cy="190" r="7"/>
|
|
17
|
+
<circle cx="1220" cy="140" r="5"/>
|
|
18
|
+
</g>
|
|
19
|
+
<g font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" fill="#3d2a00">
|
|
20
|
+
<text x="96" y="158" font-size="64" font-weight="700" letter-spacing="-1.5">Caspee Brain Audit</text>
|
|
21
|
+
<text x="98" y="210" font-size="28" font-weight="500" fill-opacity="0.82">Score and map your knowledge base. On your machine.</text>
|
|
22
|
+
</g>
|
|
23
|
+
</svg>
|
package/assets/flow.svg
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="400" viewBox="0 0 1200 400" role="img" aria-labelledby="t d">
|
|
2
|
+
<title id="t">How the audit flows</title>
|
|
3
|
+
<desc id="d">Your agent runs the CLI on your machine. The CLI downloads the audit's method, reads your folder locally, and uploads only a plain summary of numbers and a sealed report. You open the report through a private link whose key never reaches the server.</desc>
|
|
4
|
+
<defs>
|
|
5
|
+
<marker id="a" viewBox="0 0 10 10" refX="9" refY="5" markerWidth="8" markerHeight="8" orient="auto-start-reverse">
|
|
6
|
+
<path d="M0 0 L10 5 L0 10 z" fill="#3d2a00"/>
|
|
7
|
+
</marker>
|
|
8
|
+
</defs>
|
|
9
|
+
<rect width="1200" height="400" rx="20" fill="#fffdf3" stroke="#eadfb8" stroke-width="2"/>
|
|
10
|
+
<g font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif" fill="#3d2a00">
|
|
11
|
+
<!-- Your machine -->
|
|
12
|
+
<rect x="32" y="32" width="520" height="336" rx="16" fill="#ffffff" stroke="#3d2a00" stroke-width="2" stroke-dasharray="7 6"/>
|
|
13
|
+
<text x="56" y="68" font-size="18" font-weight="700" letter-spacing="1.5">YOUR MACHINE</text>
|
|
14
|
+
<rect x="56" y="96" width="210" height="96" rx="12" fill="#fff6cc" stroke="#d9b000"/>
|
|
15
|
+
<text x="161" y="136" font-size="20" font-weight="700" text-anchor="middle">Your brain</text>
|
|
16
|
+
<text x="161" y="164" font-size="15" text-anchor="middle" fill-opacity="0.75">Markdown / text folder</text>
|
|
17
|
+
<rect x="318" y="96" width="210" height="96" rx="12" fill="#fff6cc" stroke="#d9b000"/>
|
|
18
|
+
<text x="423" y="136" font-size="20" font-weight="700" text-anchor="middle">Your AI agent</text>
|
|
19
|
+
<text x="423" y="164" font-size="15" text-anchor="middle" fill-opacity="0.75">Claude Code · Codex · Cursor</text>
|
|
20
|
+
<text x="423" y="184" font-size="12" text-anchor="middle" fill-opacity="0.65">its AI provider sees what it reads</text>
|
|
21
|
+
<rect x="56" y="232" width="472" height="112" rx="12" fill="#f5c400"/>
|
|
22
|
+
<text x="292" y="274" font-size="22" font-weight="700" text-anchor="middle">@caspee/brain-audit</text>
|
|
23
|
+
<text x="292" y="304" font-size="15" text-anchor="middle">reads the folder · measures structure · seals the report</text>
|
|
24
|
+
<text x="292" y="326" font-size="15" text-anchor="middle">with AES-256-GCM under a key made here</text>
|
|
25
|
+
<path d="M161 192 V228" stroke="#3d2a00" stroke-width="2" marker-end="url(#a)"/>
|
|
26
|
+
<text x="172" y="216" font-size="13" fill-opacity="0.7">read locally</text>
|
|
27
|
+
<path d="M423 192 V228" stroke="#3d2a00" stroke-width="2" marker-end="url(#a)"/>
|
|
28
|
+
<text x="434" y="216" font-size="13" fill-opacity="0.7">runs + grades</text>
|
|
29
|
+
|
|
30
|
+
<!-- Server -->
|
|
31
|
+
<rect x="680" y="64" width="232" height="272" rx="16" fill="#ffffff" stroke="#3d2a00" stroke-width="2"/>
|
|
32
|
+
<text x="796" y="104" font-size="18" font-weight="700" text-anchor="middle">audit.caspee.ai</text>
|
|
33
|
+
<text x="796" y="140" font-size="14" text-anchor="middle" fill-opacity="0.75">MCP: tells your agent</text>
|
|
34
|
+
<text x="796" y="160" font-size="14" text-anchor="middle" fill-opacity="0.75">each step</text>
|
|
35
|
+
<text x="796" y="200" font-size="14" text-anchor="middle" fill-opacity="0.75">stores numbers and</text>
|
|
36
|
+
<text x="796" y="220" font-size="14" text-anchor="middle" fill-opacity="0.75">a report it cannot open,</text>
|
|
37
|
+
<text x="796" y="240" font-size="14" text-anchor="middle" fill-opacity="0.75">and your optional answers</text>
|
|
38
|
+
<text x="796" y="280" font-size="14" text-anchor="middle" font-weight="700">no content,</text>
|
|
39
|
+
<text x="796" y="300" font-size="14" text-anchor="middle" font-weight="700">no readable names</text>
|
|
40
|
+
|
|
41
|
+
<path d="M676 150 H560" stroke="#3d2a00" stroke-width="2" marker-end="url(#a)"/>
|
|
42
|
+
<text x="618" y="140" font-size="13" text-anchor="middle">method</text>
|
|
43
|
+
<path d="M532 288 H676" stroke="#3d2a00" stroke-width="2" marker-end="url(#a)"/>
|
|
44
|
+
<text x="604" y="276" font-size="13" text-anchor="middle">numbers +</text>
|
|
45
|
+
<text x="604" y="310" font-size="13" text-anchor="middle">sealed report</text>
|
|
46
|
+
|
|
47
|
+
<!-- You -->
|
|
48
|
+
<rect x="976" y="112" width="192" height="176" rx="16" fill="#3d2a00"/>
|
|
49
|
+
<text x="1072" y="160" font-size="20" font-weight="700" text-anchor="middle" fill="#f5c400">Your report</text>
|
|
50
|
+
<text x="1072" y="192" font-size="14" text-anchor="middle" fill="#fff6cc">private link</text>
|
|
51
|
+
<text x="1072" y="230" font-size="15" text-anchor="middle" fill="#fff6cc" font-family="ui-monospace, SFMono-Regular, Menlo, monospace">…/r/<id>#k=key</text>
|
|
52
|
+
<text x="1072" y="262" font-size="13" text-anchor="middle" fill="#fff6cc" fill-opacity="0.8">key never uploaded</text>
|
|
53
|
+
<path d="M916 200 H970" stroke="#3d2a00" stroke-width="2" marker-end="url(#a)"/>
|
|
54
|
+
</g>
|
|
55
|
+
</svg>
|