Ohm documentation#
Ohm is an AI-native browser built on Chromium (Electron for now) with three languages built in: Ohm (Lua 5.4 with LaTeX maths), Volt (a program that is a graph) and Bolt (English, translated by a local model into one of the other two).
These pages ship inside the app: press ? in the activity bar and they open as a
searchable site. npm run docs compiles this folder into it, and npm run check fails if
the compiled copy is out of date.
Guides#
Start here if you want to use Ohm.
| Guide | What it covers |
|---|---|
| Getting started | Install or build, first run, a tour of the window |
| The browser | Tabs, hidden tabs, the activity bar, the console |
| The Ohm language | Lua + LaTeX syntax, operators, the standard host API |
| Volt | The language that is a graph: parallel, re-runnable, priced before it runs |
| Bolt | English in, a program out, via a local model — and why it is safe enough to use |
| Scripts | Writing, running, organising, importing and exporting scripts |
| Models and settings | Model profiles, credentials, the models folder, Hugging Face, embedded llama.cpp, web models |
| Projects | Projects, links, docs and data, deep research |
| Prompts | Templates, typed variables, versions, the playground |
| Experiments | Datasets, sweeps, evaluators, results |
| Curves | Piecewise curves, interpolations, equations, typed output |
| Specs | The hierarchical spec editor |
| Graphs | The Rete.js editor, profiles, compiling a graph to Ohm |
| The Context tab | Open tabs, what is on each page, set algebra over tabs, exporting |
| Documents | PDF, Word, spreadsheet and slide viewers, and annotations |
| Library and remote endpoints | Reusable prompts and functions, REST endpoints, the send switch |
| View templates and results | Turning a result into a page, and the Results panel |
| Apps | Installing, auditing and publishing apps: the manifest, capabilities, and what each one may reach |
| Storage | Where everything is kept, bundles, the browser mirror |
Reference#
| Reference | What it covers |
|---|---|
| Script API | Every function a script can call |
| Operators | Every AI operator: arguments, return value, example — generated from the registry |
| File formats | Every JSON document Ohm writes |
| Protocol | The UI ↔ core methods and events |
| Keyboard | Shortcuts |
| Environment | Environment variables and paths |
Building and packaging#
| Document | What it covers |
|---|---|
| Developer guide | Setup, the repo map, adding a feature end to end, debugging, the review checklist |
| Coding guide | How code is written here: conventions, errors, tests, and the traps already hit |
| Build and package | The dev loop, the production build, the installers |
| Architecture | How the pieces fit, and the Chromium-fork seam |
Those three are also written to the repository root as single self-contained pages —
DeveloperGuide.html, CodingGuide.html and build.html — for handing to someone who has
neither the app nor the repository.
Specs#
docs/specs holds a hierarchical specification of every feature —
detailed enough to rebuild the product from. The specs are authored as data, validated in
CI, and published both as Markdown and as .spec.json files you can open in Ohm's own
spec editor.