substrate-ai 0.19.54 → 0.20.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/README.md +30 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -340,6 +340,33 @@ substrate factory twins status
|
|
|
340
340
|
substrate factory twins down
|
|
341
341
|
```
|
|
342
342
|
|
|
343
|
+
## Using as a Library
|
|
344
|
+
|
|
345
|
+
Substrate ships as a family of npm packages. Most users just want the CLI (`substrate-ai`); the scoped packages are for downstream projects that want to embed substrate pieces directly.
|
|
346
|
+
|
|
347
|
+
| Package | Use when you want... |
|
|
348
|
+
|---------|----------------------|
|
|
349
|
+
| `substrate-ai` | The full CLI — installed globally |
|
|
350
|
+
| `@substrate-ai/core` | Transport-agnostic primitives — event bus, adapters, cost tracker, telemetry, config schema |
|
|
351
|
+
| `@substrate-ai/sdlc` | SDLC orchestration — phase handlers, graph orchestrator, verification pipeline, learning loop |
|
|
352
|
+
| `@substrate-ai/factory` | Graph engine, scenario runner, convergence loop, digital twin helpers, LLM client |
|
|
353
|
+
|
|
354
|
+
All four packages release in lockstep on every `v*` tag push — pick a version and mix any combination:
|
|
355
|
+
|
|
356
|
+
```bash
|
|
357
|
+
npm install @substrate-ai/core @substrate-ai/factory
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
```typescript
|
|
361
|
+
import { createEventBus } from '@substrate-ai/core'
|
|
362
|
+
import { parseGraph, createGraphExecutor } from '@substrate-ai/factory'
|
|
363
|
+
import { createSdlcEventBridge } from '@substrate-ai/sdlc'
|
|
364
|
+
|
|
365
|
+
// Compose these primitives in your own orchestrator.
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
TypeScript declaration files are bundled in each package. Published tarballs carry an npm provenance attestation you can verify with `npm audit signatures`.
|
|
369
|
+
|
|
343
370
|
## Configuration
|
|
344
371
|
|
|
345
372
|
Substrate reads configuration from `.substrate/config.yaml` in your project root. Run `substrate init` to generate defaults.
|
|
@@ -461,17 +488,11 @@ git clone https://github.com/johnplanow/substrate.git
|
|
|
461
488
|
cd substrate
|
|
462
489
|
npm install
|
|
463
490
|
npm run build
|
|
464
|
-
npm test
|
|
491
|
+
npm run test:fast # ~50s unit suite for iteration
|
|
492
|
+
npm test # full suite with coverage — run before merging
|
|
465
493
|
```
|
|
466
494
|
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
| Package | Purpose |
|
|
470
|
-
|---------|---------|
|
|
471
|
-
| `substrate-ai` | CLI entry point, pipeline orchestrators, methodology packs |
|
|
472
|
-
| `@substrate-ai/core` | Transport-agnostic infrastructure — adapters, dispatch, routing, persistence, telemetry |
|
|
473
|
-
| `@substrate-ai/sdlc` | SDLC graph orchestrator, DOT pipeline topology, event handlers |
|
|
474
|
-
| `@substrate-ai/factory` | Software factory — scenarios, convergence, direct API backend, digital twins |
|
|
495
|
+
The repo is an npm workspaces monorepo — see [Using as a Library](#using-as-a-library) for the four packages it publishes. Release mechanics live in `scripts/sync-workspace-versions.mjs` and `.github/workflows/publish.yml`: every `v*` tag push syncs the workspace package versions to the root, dry-runs all four tarballs, and publishes via npm OIDC trusted publishing.
|
|
475
496
|
|
|
476
497
|
## License
|
|
477
498
|
|