cl-dataflow

cl-dataflow is a Common Lisp library for composable computation graphs: pipelines, event-driven workflows, guarded state machines, effect boundaries, lazy streams, and their push-based reactive dual. It targets SBCL, exports a single package, and takes two runtime dependencies: cl-prolog, which backs the graph edge relation, and cl-concurrent-kit, which backs run-pipeline's optional :parallel mode. Where a general-purpose graph library gives you data structures, cl-dataflow gives you a runtime: graphs that execute, carry a context, record a trace, and hand control to a state machine.

Full documentation is published at https://nerima-lisp.github.io/cl-dataflow/. The source for that site lives in docs/src/.

Quick Start

(asdf:load-system "cl-dataflow")

(defparameter *pipeline*
  (cl-dataflow:define-pipeline ()
    (:node "start"
     :handler (lambda (input context)
                (declare (ignore context))
                (1+ input)))
    (:node "finish"
     :handler (lambda (input context)
                (declare (ignore context))
                (* input 2)))
    (:edge "start" "finish")))

(cl-dataflow:run-pipeline *pipeline* :input 10)
;; => 22

Install

# flake.nix
inputs.cl-dataflow = {
  url = "github:nerima-lisp/cl-dataflow/v1.0.0";
  inputs.nixpkgs.follows = "nixpkgs";
};

Note the pinned tag. Consumers inside this org pin a release tag rather than follow the default branch.

Outside Nix, put this checkout, cl-prolog, and cl-concurrent-kit somewhere ASDF can see them — ~/quicklisp/local-projects/, asdf:*central-registry*, or CL_SOURCE_REGISTRY — then add "cl-dataflow" to your system's :depends-on. Full instructions are in Installation.

Documentation

• Quick Start — one pipeline, start to finish
• Core Concepts — nodes, edges, graphs, contexts, events, effects, state machines
• API Reference — every exported symbol
• Architecture — how the runtime is split, and the feature-by-feature status table

Development

nix develop          # SBCL with CL_SOURCE_REGISTRY already set
nix run .#test       # run the test suite
nix run .#watch      # re-run the suite on every source change
nix flake check      # tests + coverage + lint + formatting + docs, as CI runs it
nix fmt              # format Nix sources (treefmt)

Without Nix, sbcl --script run-tests.lisp runs the same suite, given a CL_SOURCE_REGISTRY that resolves the dependencies.

Tests live in t/ and run under cl-weave, the org's test framework. nix flake check additionally enforces the coverage gate (84% expression, 100% branch), the paredit lint pass, and a mkdocs --strict docs build. See Development.

Contributing

See the org-wide CONTRIBUTING guide and the package standard.

Support

See SUPPORT.

License

MIT. See LICENSE.