Repository navigation
architecture
github-actions[bot] edited this page Nov 5, 2026
·
2 revisions
How the code of the core is laid out and why. What each element means is in the glossary; this part says how the code holds it.
┌────────────── interfaces ──────────────┐
│ cli.ts (bos <model> <tool>) index.ts │ how people and programs reach BOS
└───────────────────┬────────────────────┘
tools/ one entry per command: args, run, render
│
bos.ts class BOS the spine: bootstrap, inspect, watch, bumpScope
│
┌───────────────┴───────────────┐
procedures/ models/ how (named steps) · what (the glossary as classes)
└───────────────┬───────────────┘
core/ Host, Element, Procedure, Tool, versions, paths
│
hosts/ NodeHost the one door to the machine
│
bridges (phase 2+) git, GitHub, Gitea, docker, setternet…
- Models: the tree of elements, and the anatomy every model shares.
- Interfaces: the ways in: the CLI, the library, later an API and more.
- Bridges: the ways out: other systems BOS talks to.
-
Workflows: the craft loop on GitHub, calling
bos flow.
Three rules hold it together (AGENTS.md has all of them):
-
One door to the machine. Only
src/hosts/importsnode:*(andcli.ts, to start). Everything else asks aHost, so the core can run wherever a host can be written. -
Code is the procedure. A behaviour is a procedure: a directory with a
DESCRIPTION.md(why), one file per step (how),_index.ts(the order). - BOS creates only what is missing, and a dry run plans exactly what the real run does.
Blacksmith Organization System 1.14.1 · repository · documentation · generated from docs/ by scripts/gh-wiki.py, do not edit here
Home · 1.14.1
- Architecture
- Devlog
- Changelog
- For agents
-
Glossary
- BOS glossary
- Network
- Workshop
- Loop
- Elements