stroblme
b2aa932b6d
Docs / docs (push) Successful in 26s
Playwright Tests / test-playwright (1, 2) (push) Failing after 4m7s
Playwright Tests / test-playwright (2, 2) (push) Failing after 2m30s
pre-commit / pre-commit (push) Failing after 2m42s
Test Backend / test-backend (push) Failing after 3m3s
Compose Smoke Test / test-compose (push) Successful in 32s
Playwright Tests / merge-reports (push) Successful in 1m51s
44 lines
2.3 KiB
Plaintext
44 lines
2.3 KiB
Plaintext
# Fluksio
|
|
|
|
> Fluksio is a node-based automation engine for live flows and batch runs.
|
|
> Nodes connect through typed, named messages. Start with pip for data science
|
|
> or Docker for facility automation; connect to a portal for optional remote
|
|
> access. Data stays on the instance.
|
|
|
|
## Getting started
|
|
|
|
- [Pick your starting point](/getting-started/): choose data science or facility automation
|
|
- [Data science](/getting-started/data-science/): pip setup, a Python function, and a first run
|
|
- [Facility automation](/getting-started/facility-automation/): Docker setup, a live flow, dashboards, and devices
|
|
|
|
## Concepts
|
|
|
|
- [Flows, nodes and messages](/concepts/flows/): the graph comes from message names, not drawn wires
|
|
- [Where a node's values come from](/concepts/values/): ports, settings, flow inputs
|
|
- [Keeping state in a flow](/concepts/state/): a message a node both reads and writes
|
|
- [Runs: pipelines that finish](/concepts/runs/): batch mode, metrics, artifacts, sweeps, durability
|
|
|
|
## The interface
|
|
|
|
- [The dashboard app](/interface/): the shell, Home, health and activity
|
|
- [The flow editor](/interface/flow-editor/): canvas, node panel, dock, shortcuts, drafts
|
|
- [Dashboards and panels](/interface/dashboards/): widgets, typed bindings, wall screens
|
|
- [Secrets, modules and alerts](/interface/operations/): credentials, packages, failure routing
|
|
- [Accounts and the portal](/interface/portal/): enrolment, remote users, revoking
|
|
|
|
## Code and the CLI
|
|
|
|
- [The fluksio command](/code/cli/): serve, enroll, worker, and the data directory
|
|
- [Writing node code](/code/nodes/): process(), generators, fluksio.emit, artifacts
|
|
- [The HTTP API](/code/api/): auth, flows, messages, runs, observability, websocket
|
|
- [Remote workers](/code/workers/): fluksio-worker, device labels, artifacts across hosts
|
|
- [Agents over MCP](/code/agents/): the tool list and the security model
|
|
- [Writing a connector](/code/connectors/): packaging a device integration as a node type
|
|
|
|
## Reference
|
|
|
|
- [Node types](/reference/node-types/): every built-in type and its settings
|
|
- [Payload types](/reference/payload-types/): float, int, str, bool, json, record, list, series, artifact
|
|
- [Configuration](/reference/configuration/): every environment variable
|
|
- [The connector contract](/reference/connector-contract/): what a connector package must provide
|