@christianirack/create-brainllm 0.6.1 → 0.8.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 +36 -34
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ npm run dev
|
|
|
10
10
|
|
|
11
11
|
Runs the same pinned BRAINLLM compiler and installs the generated app dependencies. Pass `-- --no-install` to skip dependency installation.
|
|
12
12
|
|
|
13
|
-
<p align="center"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.
|
|
13
|
+
<p align="center"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.8.0/docs/site/assets/logo.png" width="88" alt="BRAINLLM brain mark"></p>
|
|
14
14
|
|
|
15
15
|
# BRAINLLM
|
|
16
16
|
|
|
@@ -25,10 +25,10 @@ Runs the same pinned BRAINLLM compiler and installs the generated app dependenci
|
|
|
25
25
|
<img src="https://img.shields.io/badge/built%20with-Rust-dea584?logo=rust&logoColor=white" alt="Built with Rust">
|
|
26
26
|
<a href="https://chrisifm.github.io/BRAINLLM/"><img src="https://img.shields.io/badge/website-chrisifm.github.io%2FBRAINLLM-0071e3" alt="Website"></a>
|
|
27
27
|
<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>
|
|
28
|
-
<a href="https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
28
|
+
<a href="https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/LICENSE"><img src="https://img.shields.io/github/license/chrisifm/BRAINLLM" alt="License"></a>
|
|
29
29
|
</p>
|
|
30
30
|
|
|
31
|
-
<p align="center"><a href="https://chrisifm.github.io/BRAINLLM/"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.
|
|
31
|
+
<p align="center"><a href="https://chrisifm.github.io/BRAINLLM/"><img src="https://raw.githubusercontent.com/chrisifm/BRAINLLM/v0.8.0/docs/site/assets/cover.png" alt="BRAINLLM — The web compiler for LLMs. Open the website: chrisifm.github.io/BRAINLLM"></a></p>
|
|
32
32
|
|
|
33
33
|
<p align="center"><b>🌐 <a href="https://chrisifm.github.io/BRAINLLM/">chrisifm.github.io/BRAINLLM</a></b></p>
|
|
34
34
|
|
|
@@ -45,9 +45,11 @@ automatically to a review branch. Maintainers decide what merges.
|
|
|
45
45
|
|
|
46
46
|
## Built for agents that change code safely
|
|
47
47
|
|
|
48
|
-
BRAINLLM is not another React, Next or Node
|
|
49
|
-
|
|
50
|
-
|
|
48
|
+
BRAINLLM is not another React, Next or Node, and it does not try to replace them. It aims to be the first
|
|
49
|
+
self-improving compiler for LLMs: when an agent hits a compiler gap, `scripts/evolve.mjs` turns it into an isolated,
|
|
50
|
+
tested proposal, and a person decides whether it ships. No change merges itself. Every claim below is a command you can
|
|
51
|
+
run; the numbers are under [the benchmarks](#show-me-the-numbers). The tools other stacks sell as advanced analysis are
|
|
52
|
+
the baseline here:
|
|
51
53
|
|
|
52
54
|
- **Locate without reading.** `brain map`, `brain card`, `brain graph`, `brain context` and symbol search give an
|
|
53
55
|
agent the contract and the exact location of what it must touch, never a 2,000-line file.
|
|
@@ -59,14 +61,14 @@ for human review. The tools other stacks sell as advanced analysis are the basel
|
|
|
59
61
|
- **Real-time evidence while developing.** Compiler feedback, impact per save (diagnostics and bytes per view),
|
|
60
62
|
runtime errors mapped to `.brain` lines, memory and leak inspection, over CLI and MCP.
|
|
61
63
|
|
|
62
|
-
**[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.
|
|
64
|
+
**[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.8.0/SPEC.md)** · **[See the benchmarks](#show-me-the-numbers)** · **[Contribute](#build-the-tool-your-agent-needs)**
|
|
63
65
|
|
|
64
66
|
## A frontend language with the model in mind
|
|
65
67
|
|
|
66
68
|
An agent writing your app needs a contract it can follow and feedback it can act on. BRAINLLM makes that loop
|
|
67
69
|
explicit: read the spec, generate a component, check it, apply the fix, test the result.
|
|
68
70
|
|
|
69
|
-

|
|
70
72
|
|
|
71
73
|
- **Less to guess.** `brain spec` defines the supported language. One component format, a prescribed project
|
|
72
74
|
structure and generators keep the model working inside a known contract.
|
|
@@ -94,7 +96,7 @@ agent has to reconstruct while preserving code that a developer can read and rev
|
|
|
94
96
|
| Verification and delivery | Tests, `brain doctor` and the production build make validation part of the workflow |
|
|
95
97
|
| Tested compiler improvements | Isolated proposals, validation gates and optional review-branch pushes let the agent contribute fixes |
|
|
96
98
|
|
|
97
|
-
Use [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
99
|
+
Use [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/SPEC.md), the served `brain spec` and [EVOLUTION.md](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/EVOLUTION.md) for exact contracts and limits.
|
|
98
100
|
|
|
99
101
|
## Where it fits in the frontend stack
|
|
100
102
|
|
|
@@ -153,8 +155,8 @@ stack. Builds run serially on a shared machine. Variance matters: inspect the ra
|
|
|
153
155
|
The output strategies differ (including SSR, client rendering and an Astro React island); this comparison measures
|
|
154
156
|
production build duration for this fixture, not universal app performance or feature equivalence.
|
|
155
157
|
|
|
156
|
-
Read the [expanded method, versions, payloads and results](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
157
|
-
[historical results](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
158
|
+
Read the [expanded method, versions, payloads and results](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/bench/build/expanded.md). The original three-stack
|
|
159
|
+
[historical results](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/bench/build/results/summary.md) remain available unchanged. Use `bench/build/expanded.mjs`
|
|
158
160
|
with the documented frozen binary and scratch-directory setup to reproduce this seven-stack run.
|
|
159
161
|
|
|
160
162
|
**Ask your agent to challenge the result:**
|
|
@@ -177,11 +179,11 @@ numbers support it. Do not upload results or publish anything automatically.
|
|
|
177
179
|
Clean up only the temporary resources this run created.
|
|
178
180
|
```
|
|
179
181
|
|
|
180
|
-
A separate [cache-key microbenchmark](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
182
|
+
A separate [cache-key microbenchmark](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/bench/build/results/compiler-cache-lookup.json) measured **43.3× faster key
|
|
181
183
|
lookup** after removing an unnecessary parse: 10,000 lookups of a 1,050-byte input. That number measures this
|
|
182
184
|
internal operation only. It is not a full-build speedup or a webpack comparison.
|
|
183
185
|
|
|
184
|
-
The [benchmark report](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
186
|
+
The [benchmark report](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/bench/REPORT.md) also tracks agent-generated apps, browser behavior, payload size and
|
|
185
187
|
failure recovery. Historical LLM results describe their frozen model/spec/compiler runs; they do not guarantee
|
|
186
188
|
that a new prompt or compiler revision will pass. This project is open to developers and researchers who want to
|
|
187
189
|
investigate how language design and compiler feedback affect agent behavior. Bring a hypothesis and a reproducer.
|
|
@@ -205,7 +207,7 @@ what each result actually establishes.
|
|
|
205
207
|
|
|
206
208
|
Browser tooling and the preview supervisor currently require macOS or Linux. Screenshot baselines need stable browser,
|
|
207
209
|
font and app-data inputs. Runtime mount-time/heap budgets remain planned; the compiler rejects those settings rather
|
|
208
|
-
than pretending to measure them. See the [implemented contract](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
210
|
+
than pretending to measure them. See the [implemented contract](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/SPEC.md) and [tool internals](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/INTERNALS.md).
|
|
209
211
|
|
|
210
212
|
## Give your agent its first task
|
|
211
213
|
|
|
@@ -299,11 +301,11 @@ For an existing app, run `brain agent setup` to merge local registrations, or
|
|
|
299
301
|
The hook checks the app after `.brain`, `.jsbrain` and `.cssbrain` edits; it does not run tests or download packages.
|
|
300
302
|
Use `brain mcp --profile minimal` for six core tools, or `--profile backend` for resource/job contracts and generators.
|
|
301
303
|
With a source installation, change the registration to command `brain` and arguments `["mcp"]`.
|
|
302
|
-
Other clients use their own MCP settings. See [the backend/agent contract](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
304
|
+
Other clients use their own MCP settings. See [the backend/agent contract](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/BACKEND.md).
|
|
303
305
|
|
|
304
306
|
</details>
|
|
305
307
|
|
|
306
|
-
For an existing frontend, start with the [migration workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
308
|
+
For an existing frontend, start with the [migration workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/MIGRATION.md). Its read-only planner recognizes
|
|
307
309
|
React, Angular, Vue, Svelte, Next and Nuxt projects. Port one tested route or component at a time, preserve its
|
|
308
310
|
behavior and keep a rollback path. It is an incremental workflow, not an automatic transpiler.
|
|
309
311
|
|
|
@@ -321,7 +323,7 @@ behavior and keep a rollback path. It is an incremental workflow, not an automat
|
|
|
321
323
|
```
|
|
322
324
|
|
|
323
325
|
The compiler handles signal reads and writes. Derived values update when their inputs change. Styles can live in
|
|
324
|
-
the same file and are scoped to the component. The [served spec](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
326
|
+
the same file and are scoped to the component. The [served spec](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/SPEC.md) defines the supported syntax.
|
|
325
327
|
|
|
326
328
|
## Readable intent. Lean browser output.
|
|
327
329
|
|
|
@@ -329,7 +331,7 @@ An internal function named `back_to_home` can become a short identifier in produ
|
|
|
329
331
|
on scope and the other names in the module. Keep meaningful names where the agent reasons about the code; let the
|
|
330
332
|
compiler shorten eligible bindings in what the browser receives.
|
|
331
333
|
|
|
332
|
-
This example comes from the [minifier's scope regression tests](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
334
|
+
This example comes from the [minifier's scope regression tests](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/crates/brain-min/src/mangle.rs):
|
|
333
335
|
|
|
334
336
|
```js
|
|
335
337
|
// Before
|
|
@@ -364,29 +366,29 @@ BRAINLLM includes protections at several stages of the app loop:
|
|
|
364
366
|
tests and diagnostics; failed stages remain visible to the agent.
|
|
365
367
|
|
|
366
368
|
These are implemented mechanisms, not a promise to catch every bug or repair every failure. The agent still needs
|
|
367
|
-
to test the user's workflow. See [runtime behavior in the spec](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
368
|
-
[component boundaries](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
369
|
+
to test the user's workflow. See [runtime behavior in the spec](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/SPEC.md#errors-at-runtime),
|
|
370
|
+
[component boundaries](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/runtime/brain-guard.js) and [compiler diagnostics](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/crates/brain-check/).
|
|
369
371
|
|
|
370
372
|
## Build the tool your agent needs
|
|
371
373
|
|
|
372
374
|
**Build with it. Let your LLM make it better.**
|
|
373
375
|
|
|
374
|
-

|
|
375
377
|
|
|
376
378
|
A failed compilation can become a regression test. A repeated slow step can become a benchmark. A fix made while
|
|
377
379
|
building your app can become a contribution that helps the next developer and their agent.
|
|
378
380
|
|
|
379
381
|
Found a compiler gap while building an app? Turn the smallest reproducible case into a regression test and a
|
|
380
|
-
contribution. BRAINLLM includes an [evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
382
|
+
contribution. BRAINLLM includes an [evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/EVOLUTION.md) for isolated proposals, validated compiler
|
|
381
383
|
binaries and reversible activation. Configured automatic pushes go to review branches; merges require the
|
|
382
384
|
principal author's review. This is an explicit development workflow, not a compiler that silently rewrites itself
|
|
383
|
-
on every build. Read the [agent improvement playbook](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
385
|
+
on every build. Read the [agent improvement playbook](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/AGENT-IDEAS.md) for an opt-in prompt and concrete ideas
|
|
384
386
|
to investigate.
|
|
385
387
|
|
|
386
388
|
Human developers and LLM contributors are welcome. Useful first contributions include reproducible compiler bugs,
|
|
387
389
|
behavior-preserving migration examples, clearer diagnostics and performance improvements with before/after data.
|
|
388
390
|
|
|
389
|
-
1. Read [CONTRIBUTING.md](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
391
|
+
1. Read [CONTRIBUTING.md](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/CONTRIBUTING.md) and the relevant [internals](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/INTERNALS.md).
|
|
390
392
|
2. Make a focused change with a regression test and synthetic sample data.
|
|
391
393
|
3. Run `bash scripts/verify.sh`. It builds the CLI and checks Rust, runtime, tooling, diagnostic fixtures, privacy
|
|
392
394
|
and repository language. Verification also requires ripgrep.
|
|
@@ -397,7 +399,7 @@ Never include app secrets, private source or customer data in a contribution.
|
|
|
397
399
|
|
|
398
400
|
## Know what you are adopting
|
|
399
401
|
|
|
400
|
-
BRAINLLM is **0.
|
|
402
|
+
BRAINLLM is **0.8.0** (see [CHANGELOG.md](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/CHANGELOG.md)). Start with a small app or an isolated route and test the behavior you need. Features marked
|
|
401
403
|
as planned in the source specification are not a supported promise; `brain spec` serves the implemented contract.
|
|
402
404
|
Third-party React, Angular and Vue components do not become BRAINLLM components automatically. Benchmark wins in
|
|
403
405
|
build time do not imply that every runtime workload is faster.
|
|
@@ -406,15 +408,15 @@ build time do not imply that every runtime workload is faster.
|
|
|
406
408
|
|
|
407
409
|
| You want to… | Start here |
|
|
408
410
|
|---|---|
|
|
409
|
-
| Give an agent the project context | [llms.txt](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
410
|
-
| Write an app | [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
411
|
-
| Migrate an existing frontend | [Migration guide](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
412
|
-
| Improve the compiler while using it | [Evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
413
|
-
| Understand the implementation | [Internals](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
414
|
-
| Inspect examples and reproduce measurements | [Examples](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
415
|
-
| Contribute a change | [Contributor guide](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
411
|
+
| Give an agent the project context | [llms.txt](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/llms.txt) |
|
|
412
|
+
| Write an app | [SPEC.md](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/SPEC.md) and `brain spec` |
|
|
413
|
+
| Migrate an existing frontend | [Migration guide](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/MIGRATION.md) |
|
|
414
|
+
| Improve the compiler while using it | [Evolution workflow](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/EVOLUTION.md) and [agent ideas](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/AGENT-IDEAS.md) |
|
|
415
|
+
| Understand the implementation | [Internals](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/INTERNALS.md) and [crates](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/crates/) |
|
|
416
|
+
| Inspect examples and reproduce measurements | [Examples](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/examples/) and [benchmarks](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/bench/) |
|
|
417
|
+
| Contribute a change | [Contributor guide](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/CONTRIBUTING.md) |
|
|
416
418
|
|
|
417
|
-
Released under the [MIT license](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
419
|
+
Released under the [MIT license](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/LICENSE).
|
|
418
420
|
|
|
419
421
|
Created and maintained by **Christian Irack Flores Maldonado**, principal author.
|
|
420
422
|
[ingenieria.dev](https://ingenieria.dev) · [irack.mx](https://irack.mx) · [christian@irack.mx](mailto:christian@irack.mx)
|
|
@@ -426,5 +428,5 @@ Every merged contribution helps the next developer and their agent. Thank you to
|
|
|
426
428
|
|
|
427
429
|
[<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)
|
|
428
430
|
|
|
429
|
-
Attribution is refreshed through a reviewed pull request. [How it works](https://github.com/chrisifm/BRAINLLM/blob/v0.
|
|
431
|
+
Attribution is refreshed through a reviewed pull request. [How it works](https://github.com/chrisifm/BRAINLLM/blob/v0.8.0/docs/CONTRIBUTORS.md).
|
|
430
432
|
<!-- contributors:end -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@christianirack/create-brainllm",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "npm create @christianirack/brainllm <app>: a new BRAINLLM app (the Rust-powered full-stack web compiler for LLMs and AI agents) with its brain version pinned.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"create-brainllm": "bin/create.js"
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"node": ">=22"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@christianirack/brainllm": "0.
|
|
17
|
+
"@christianirack/brainllm": "0.8.0"
|
|
18
18
|
},
|
|
19
19
|
"keywords": [
|
|
20
20
|
"create",
|