Octonode Documentation
Canonical Octonode repository documentation.
Octonode Documentation
- first-workflow.md — start here. From
initto a running two-node workflow, then the same workflow run as a generated function. - ipc-protocol.md — the stdin/stdout JSON contract every node speaks (envelopes, error codes, one-shot vs worker transport).
- config-reference.md — the
.octonodefile: schema, the ownership model, and theinit/scan/validate/invoke/runcommands. - adding-a-language.md — write a node SDK / thin runner in any language.
- design-docs-hosting.md — R2-backed collaborative design documents, unique hosting paths, workflow/iframe embeds, review pins, and PDF export.
- task-management-architecture.md — workspace Task Spaces, work items, Board/List/Calendar/Timeline views, sprints, releases, comments, and engineering links.
- Architecture — the canonical monorepo/project/resource model and route.
CLI quick reference
| Command | What it does |
|---|---|
octonode init [path] | scaffold a .octonode (--format json|yaml) |
octonode scan | discover nodes via describe, write signatures (--check = CI gate) |
octonode validate | schema + structural checks |
octonode invoke <id> | run one node by id, injecting env + runtime |
octonode run <workflow> | execute a workflow DAG (--record <file> to capture a run; --compiled runs the generated function) |
octonode codegen orchestrate <workflow> | generate the workflow-as-function file (nodes/_workflows/<id>.js) |
octonode schema | print the versioned .octonode JSON Schema (--out/--check) |
octonode graph <workflow> | export the DAG as Mermaid or --format dot |
octonode replay <record> <id> | re-run one node from a recorded run's inputs |
octonode bench <command> | compare one-shot vs worker-mode throughput |
octonode run-node <command> | low-level: invoke/--describe a raw command |
Install
# from a clone:
yarn install && yarn build
npm link -w @octonode/cli # puts `octonode` on your PATH
# or run from source without linking:
node packages/cli/dist/index.js <command>