@christianirack/brainllm 0.6.1 → 0.7.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/README.md +31 -31
- package/brain.schema.json +27 -0
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<p align="center"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.
|
|
1
|
+
<p align="center"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.7.0/docs/site/assets/logo.png" width="88" alt="BRAINLLM brain mark"></p>
|
|
2
2
|
|
|
3
3
|
# BRAINLLM
|
|
4
4
|
|
|
@@ -13,10 +13,10 @@
|
|
|
13
13
|
<img src="https://img.shields.io/badge/built%20with-Rust-dea584?logo=rust&logoColor=white" alt="Built with Rust">
|
|
14
14
|
<a href="https://chrisifm.github.io/BRAINLLM/"><img src="https://img.shields.io/badge/website-chrisifm.github.io%2FBRAINLLM-0071e3" alt="Website"></a>
|
|
15
15
|
<a href="https://www.npmjs.com/package/@christianirack/brainllm"><img src="https://img.shields.io/npm/v/@christianirack/brainllm?color=cb3837" alt="npm version"></a>
|
|
16
|
-
<a href="https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
16
|
+
<a href="https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/LICENSE"><img src="https://img.shields.io/github/license/chrisifm/BRAINLLM" alt="License"></a>
|
|
17
17
|
</p>
|
|
18
18
|
|
|
19
|
-
<p align="center"><a href="https://chrisifm.github.io/BRAINLLM/"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.
|
|
19
|
+
<p align="center"><a href="https://chrisifm.github.io/BRAINLLM/"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.7.0/docs/site/assets/cover.png" alt="BRAINLLM — The web compiler for LLMs. Open the website: chrisifm.github.io/BRAINLLM"></a></p>
|
|
20
20
|
|
|
21
21
|
<p align="center"><b>🌐 <a href="https://chrisifm.github.io/BRAINLLM/">chrisifm.github.io/BRAINLLM</a></b></p>
|
|
22
22
|
|
|
@@ -47,14 +47,14 @@ for human review. The tools other stacks sell as advanced analysis are the basel
|
|
|
47
47
|
- **Real-time evidence while developing.** Compiler feedback, impact per save (diagnostics and bytes per view),
|
|
48
48
|
runtime errors mapped to `.brain` lines, memory and leak inspection, over CLI and MCP.
|
|
49
49
|
|
|
50
|
-
**[Visit the site](https://chrisifm.github.io/BRAINLLM/)** · **[Build your first app](#give-your-agent-its-first-task)** · **[Read the spec](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
50
|
+
**[Visit the site](https://chrisifm.github.io/BRAINLLM/)** · **[Build your first app](#give-your-agent-its-first-task)** · **[Read the spec](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/SPEC.md)** · **[See the benchmarks](#show-me-the-numbers)** · **[Contribute](#build-the-tool-your-agent-needs)**
|
|
51
51
|
|
|
52
52
|
## A frontend language with the model in mind
|
|
53
53
|
|
|
54
54
|
An agent writing your app needs a contract it can follow and feedback it can act on. BRAINLLM makes that loop
|
|
55
55
|
explicit: read the spec, generate a component, check it, apply the fix, test the result.
|
|
56
56
|
|
|
57
|
-

|
|
58
58
|
|
|
59
59
|
- **Less to guess.** `brain spec` defines the supported language. One component format, a prescribed project
|
|
60
60
|
structure and generators keep the model working inside a known contract.
|
|
@@ -82,7 +82,7 @@ agent has to reconstruct while preserving code that a developer can read and rev
|
|
|
82
82
|
| Verification and delivery | Tests, `brain doctor` and the production build make validation part of the workflow |
|
|
83
83
|
| Tested compiler improvements | Isolated proposals, validation gates and optional review-branch pushes let the agent contribute fixes |
|
|
84
84
|
|
|
85
|
-
Use [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
85
|
+
Use [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/SPEC.md), the served `brain spec` and [EVOLUTION.md](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/EVOLUTION.md) for exact contracts and limits.
|
|
86
86
|
|
|
87
87
|
## Where it fits in the frontend stack
|
|
88
88
|
|
|
@@ -141,8 +141,8 @@ stack. Builds run serially on a shared machine. Variance matters: inspect the ra
|
|
|
141
141
|
The output strategies differ (including SSR, client rendering and an Astro React island); this comparison measures
|
|
142
142
|
production build duration for this fixture, not universal app performance or feature equivalence.
|
|
143
143
|
|
|
144
|
-
Read the [expanded method, versions, payloads and results](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
145
|
-
[historical results](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
144
|
+
Read the [expanded method, versions, payloads and results](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/bench/build/expanded.md). The original three-stack
|
|
145
|
+
[historical results](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/bench/build/results/summary.md) remain available unchanged. Use `bench/build/expanded.mjs`
|
|
146
146
|
with the documented frozen binary and scratch-directory setup to reproduce this seven-stack run.
|
|
147
147
|
|
|
148
148
|
**Ask your agent to challenge the result:**
|
|
@@ -165,11 +165,11 @@ numbers support it. Do not upload results or publish anything automatically.
|
|
|
165
165
|
Clean up only the temporary resources this run created.
|
|
166
166
|
```
|
|
167
167
|
|
|
168
|
-
A separate [cache-key microbenchmark](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
168
|
+
A separate [cache-key microbenchmark](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/bench/build/results/compiler-cache-lookup.json) measured **43.3× faster key
|
|
169
169
|
lookup** after removing an unnecessary parse: 10,000 lookups of a 1,050-byte input. That number measures this
|
|
170
170
|
internal operation only. It is not a full-build speedup or a webpack comparison.
|
|
171
171
|
|
|
172
|
-
The [benchmark report](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
172
|
+
The [benchmark report](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/bench/REPORT.md) also tracks agent-generated apps, browser behavior, payload size and
|
|
173
173
|
failure recovery. Historical LLM results describe their frozen model/spec/compiler runs; they do not guarantee
|
|
174
174
|
that a new prompt or compiler revision will pass. This project is open to developers and researchers who want to
|
|
175
175
|
investigate how language design and compiler feedback affect agent behavior. Bring a hypothesis and a reproducer.
|
|
@@ -193,7 +193,7 @@ what each result actually establishes.
|
|
|
193
193
|
|
|
194
194
|
Browser tooling and the preview supervisor currently require macOS or Linux. Screenshot baselines need stable browser,
|
|
195
195
|
font and app-data inputs. Runtime mount-time/heap budgets remain planned; the compiler rejects those settings rather
|
|
196
|
-
than pretending to measure them. See the [implemented contract](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
196
|
+
than pretending to measure them. See the [implemented contract](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/SPEC.md) and [tool internals](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/INTERNALS.md).
|
|
197
197
|
|
|
198
198
|
## Give your agent its first task
|
|
199
199
|
|
|
@@ -287,11 +287,11 @@ For an existing app, run `brain agent setup` to merge local registrations, or
|
|
|
287
287
|
The hook checks the app after `.brain`, `.jsbrain` and `.cssbrain` edits; it does not run tests or download packages.
|
|
288
288
|
Use `brain mcp --profile minimal` for six core tools, or `--profile backend` for resource/job contracts and generators.
|
|
289
289
|
With a source installation, change the registration to command `brain` and arguments `["mcp"]`.
|
|
290
|
-
Other clients use their own MCP settings. See [the backend/agent contract](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
290
|
+
Other clients use their own MCP settings. See [the backend/agent contract](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/BACKEND.md).
|
|
291
291
|
|
|
292
292
|
</details>
|
|
293
293
|
|
|
294
|
-
For an existing frontend, start with the [migration workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
294
|
+
For an existing frontend, start with the [migration workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/MIGRATION.md). Its read-only planner recognizes
|
|
295
295
|
React, Angular, Vue, Svelte, Next and Nuxt projects. Port one tested route or component at a time, preserve its
|
|
296
296
|
behavior and keep a rollback path. It is an incremental workflow, not an automatic transpiler.
|
|
297
297
|
|
|
@@ -309,7 +309,7 @@ behavior and keep a rollback path. It is an incremental workflow, not an automat
|
|
|
309
309
|
```
|
|
310
310
|
|
|
311
311
|
The compiler handles signal reads and writes. Derived values update when their inputs change. Styles can live in
|
|
312
|
-
the same file and are scoped to the component. The [served spec](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
312
|
+
the same file and are scoped to the component. The [served spec](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/SPEC.md) defines the supported syntax.
|
|
313
313
|
|
|
314
314
|
## Readable intent. Lean browser output.
|
|
315
315
|
|
|
@@ -317,7 +317,7 @@ An internal function named `back_to_home` can become a short identifier in produ
|
|
|
317
317
|
on scope and the other names in the module. Keep meaningful names where the agent reasons about the code; let the
|
|
318
318
|
compiler shorten eligible bindings in what the browser receives.
|
|
319
319
|
|
|
320
|
-
This example comes from the [minifier's scope regression tests](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
320
|
+
This example comes from the [minifier's scope regression tests](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/crates/brain-min/src/mangle.rs):
|
|
321
321
|
|
|
322
322
|
```js
|
|
323
323
|
// Before
|
|
@@ -352,29 +352,29 @@ BRAINLLM includes protections at several stages of the app loop:
|
|
|
352
352
|
tests and diagnostics; failed stages remain visible to the agent.
|
|
353
353
|
|
|
354
354
|
These are implemented mechanisms, not a promise to catch every bug or repair every failure. The agent still needs
|
|
355
|
-
to test the user's workflow. See [runtime behavior in the spec](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
356
|
-
[component boundaries](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
355
|
+
to test the user's workflow. See [runtime behavior in the spec](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/SPEC.md#errors-at-runtime),
|
|
356
|
+
[component boundaries](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/runtime/brain-guard.js) and [compiler diagnostics](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/crates/brain-check/).
|
|
357
357
|
|
|
358
358
|
## Build the tool your agent needs
|
|
359
359
|
|
|
360
360
|
**Build with it. Let your LLM make it better.**
|
|
361
361
|
|
|
362
|
-

|
|
363
363
|
|
|
364
364
|
A failed compilation can become a regression test. A repeated slow step can become a benchmark. A fix made while
|
|
365
365
|
building your app can become a contribution that helps the next developer and their agent.
|
|
366
366
|
|
|
367
367
|
Found a compiler gap while building an app? Turn the smallest reproducible case into a regression test and a
|
|
368
|
-
contribution. BRAINLLM includes an [evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
368
|
+
contribution. BRAINLLM includes an [evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/EVOLUTION.md) for isolated proposals, validated compiler
|
|
369
369
|
binaries and reversible activation. Configured automatic pushes go to review branches; merges require the
|
|
370
370
|
principal author's review. This is an explicit development workflow, not a compiler that silently rewrites itself
|
|
371
|
-
on every build. Read the [agent improvement playbook](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
371
|
+
on every build. Read the [agent improvement playbook](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/AGENT-IDEAS.md) for an opt-in prompt and concrete ideas
|
|
372
372
|
to investigate.
|
|
373
373
|
|
|
374
374
|
Human developers and LLM contributors are welcome. Useful first contributions include reproducible compiler bugs,
|
|
375
375
|
behavior-preserving migration examples, clearer diagnostics and performance improvements with before/after data.
|
|
376
376
|
|
|
377
|
-
1. Read [CONTRIBUTING.md](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
377
|
+
1. Read [CONTRIBUTING.md](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/CONTRIBUTING.md) and the relevant [internals](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/INTERNALS.md).
|
|
378
378
|
2. Make a focused change with a regression test and synthetic sample data.
|
|
379
379
|
3. Run `bash scripts/verify.sh`. It builds the CLI and checks Rust, runtime, tooling, diagnostic fixtures, privacy
|
|
380
380
|
and repository language. Verification also requires ripgrep.
|
|
@@ -385,7 +385,7 @@ Never include app secrets, private source or customer data in a contribution.
|
|
|
385
385
|
|
|
386
386
|
## Know what you are adopting
|
|
387
387
|
|
|
388
|
-
BRAINLLM is **0.
|
|
388
|
+
BRAINLLM is **0.7.0** (see [CHANGELOG.md](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/CHANGELOG.md)). Start with a small app or an isolated route and test the behavior you need. Features marked
|
|
389
389
|
as planned in the source specification are not a supported promise; `brain spec` serves the implemented contract.
|
|
390
390
|
Third-party React, Angular and Vue components do not become BRAINLLM components automatically. Benchmark wins in
|
|
391
391
|
build time do not imply that every runtime workload is faster.
|
|
@@ -394,15 +394,15 @@ build time do not imply that every runtime workload is faster.
|
|
|
394
394
|
|
|
395
395
|
| You want to… | Start here |
|
|
396
396
|
|---|---|
|
|
397
|
-
| Give an agent the project context | [llms.txt](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
398
|
-
| Write an app | [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
399
|
-
| Migrate an existing frontend | [Migration guide](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
400
|
-
| Improve the compiler while using it | [Evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
401
|
-
| Understand the implementation | [Internals](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
402
|
-
| Inspect examples and reproduce measurements | [Examples](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
403
|
-
| Contribute a change | [Contributor guide](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
397
|
+
| Give an agent the project context | [llms.txt](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/llms.txt) |
|
|
398
|
+
| Write an app | [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/SPEC.md) and `brain spec` |
|
|
399
|
+
| Migrate an existing frontend | [Migration guide](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/MIGRATION.md) |
|
|
400
|
+
| Improve the compiler while using it | [Evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/EVOLUTION.md) and [agent ideas](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/AGENT-IDEAS.md) |
|
|
401
|
+
| Understand the implementation | [Internals](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/INTERNALS.md) and [crates](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/crates/) |
|
|
402
|
+
| Inspect examples and reproduce measurements | [Examples](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/examples/) and [benchmarks](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/bench/) |
|
|
403
|
+
| Contribute a change | [Contributor guide](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/CONTRIBUTING.md) |
|
|
404
404
|
|
|
405
|
-
Released under the [MIT license](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
405
|
+
Released under the [MIT license](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/LICENSE).
|
|
406
406
|
|
|
407
407
|
Created and maintained by **Christian Irack Flores Maldonado**, principal author.
|
|
408
408
|
[ingenieria.dev](https://ingenieria.dev) · [irack.mx](https://irack.mx) · [christian@irack.mx](mailto:christian@irack.mx)
|
|
@@ -414,5 +414,5 @@ Every merged contribution helps the next developer and their agent. Thank you to
|
|
|
414
414
|
|
|
415
415
|
[<img src="https://avatars.githubusercontent.com/u/1562002?v=4" width="48" height="48" alt="chrisifm">](https://github.com/chrisifm) [chrisifm](https://github.com/chrisifm)
|
|
416
416
|
|
|
417
|
-
Attribution is refreshed through a reviewed pull request. [How it works](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
417
|
+
Attribution is refreshed through a reviewed pull request. [How it works](https://github.com/chrisifm/BRAINLLM/blob/v0.7.0/docs/CONTRIBUTORS.md).
|
|
418
418
|
<!-- contributors:end -->
|
package/brain.schema.json
CHANGED
|
@@ -5,9 +5,26 @@
|
|
|
5
5
|
"description": "BRAINLLM app configuration. Precedence: flag > BRAIN_* variable > brain.json > defaults.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
|
+
"trace": {
|
|
9
|
+
"type": "object",
|
|
10
|
+
"description": "`brain trace`, the development capture of `brain run`. It never reaches a production build.",
|
|
11
|
+
"additionalProperties": false,
|
|
12
|
+
"properties": {
|
|
13
|
+
"enabled": { "type": "boolean", "default": true },
|
|
14
|
+
"redact": { "type": "array", "items": { "type": "string" }, "description": "Extra field names to hide, on top of passwords, tokens, cookies and secrets" },
|
|
15
|
+
"maxBodyKB": { "type": "integer", "minimum": 1, "default": 16 },
|
|
16
|
+
"maxMB": { "type": "integer", "minimum": 1, "default": 64 },
|
|
17
|
+
"maxAgeHours": { "type": "integer", "minimum": 1, "default": 72 }
|
|
18
|
+
}
|
|
19
|
+
},
|
|
8
20
|
"$schema": {
|
|
9
21
|
"type": "string"
|
|
10
22
|
},
|
|
23
|
+
"brainVersion": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(-[0-9A-Za-z.-]+)?$",
|
|
26
|
+
"description": "Exact BRAINLLM version this app's source targets. Written by `brain new`; `brain upgrade` reports the changes since it and `brain upgrade --apply` advances it."
|
|
27
|
+
},
|
|
11
28
|
"name": {
|
|
12
29
|
"type": "string",
|
|
13
30
|
"description": "App name (SEO, web manifest)."
|
|
@@ -127,6 +144,16 @@
|
|
|
127
144
|
}
|
|
128
145
|
}
|
|
129
146
|
},
|
|
147
|
+
"doctor": {
|
|
148
|
+
"type": "object",
|
|
149
|
+
"additionalProperties": false,
|
|
150
|
+
"properties": {
|
|
151
|
+
"failOnSuspectedLeaks": {
|
|
152
|
+
"type": "boolean",
|
|
153
|
+
"description": "Make `brain doctor` fail on B0601, an instance still alive after GC. Off by default: B0601 is a suspicion and is reported as a warning."
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
},
|
|
130
157
|
"seo": {
|
|
131
158
|
"type": "object",
|
|
132
159
|
"properties": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@christianirack/brainllm",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
4
|
"description": "BRAINLLM: the Rust-powered full-stack web compiler for LLMs and AI agents. Native brain CLI, dev server, optimized builds, PostgreSQL backend and MCP server.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"brain": "bin/brain.js"
|
|
@@ -15,13 +15,13 @@
|
|
|
15
15
|
"node": ">=22"
|
|
16
16
|
},
|
|
17
17
|
"optionalDependencies": {
|
|
18
|
-
"@christianirack/brainllm-darwin-arm64": "0.
|
|
19
|
-
"@christianirack/brainllm-darwin-x64": "0.
|
|
20
|
-
"@christianirack/brainllm-linux-x64": "0.
|
|
21
|
-
"@christianirack/brainllm-linux-arm64": "0.
|
|
22
|
-
"@christianirack/brainllm-linux-x64-musl": "0.
|
|
23
|
-
"@christianirack/brainllm-win32-x64": "0.
|
|
24
|
-
"@christianirack/brainllm-win32-arm64": "0.
|
|
18
|
+
"@christianirack/brainllm-darwin-arm64": "0.7.0",
|
|
19
|
+
"@christianirack/brainllm-darwin-x64": "0.7.0",
|
|
20
|
+
"@christianirack/brainllm-linux-x64": "0.7.0",
|
|
21
|
+
"@christianirack/brainllm-linux-arm64": "0.7.0",
|
|
22
|
+
"@christianirack/brainllm-linux-x64-musl": "0.7.0",
|
|
23
|
+
"@christianirack/brainllm-win32-x64": "0.7.0",
|
|
24
|
+
"@christianirack/brainllm-win32-arm64": "0.7.0"
|
|
25
25
|
},
|
|
26
26
|
"keywords": [
|
|
27
27
|
"llm",
|