Axial
Repository F# setup
open System
open System.IO
open System.Threading
open System.Threading.Tasks
open Axial
open Axial.Layers
open Axial.Console
open Axial.FileSystem
open Axial.Hosting
open Axial.Hosting.Browser
open Axial.Hosting.Node
open Axial.HttpClient
open Axial.PlatformService
open Axial.Process
open Axial.State
open Axial.Telemetry
open Axial.Telemetry.JavaScript

Installation

Install the Axial package to use Flow<'env, 'error, 'value> and the flow { } computation expression.

This documentation uses "Flow" for the workflow model and "Axial" for the library or a package name.

Install the core package:

dotnet add package Axial

Open the namespace where you define workflows:

open Axial
The package contains the workflow type, the `flow { }` builder, the runtime, structured concurrency, schedules, and the application lifecycle.

Platform services and hosts ship as separate packages. Add one only when your application needs that integration:

dotnet add package Axial.HttpClient
dotnet add package Axial.Hosting

See Packages and Platforms for the complete package map.

Add effect-boundary guardrails (optional)

A workflow can bypass its declared dependencies by reading ambient state such as DateTime.Now or by creating System.Random directly. Axial.Guardrails detects these calls and related Axial usage errors during the build.

Install the analyzer package:

dotnet add package Axial.Guardrails

The package configures the analyzer automatically. Findings are warnings by default, so you can add it to an existing project without failing the build.

Review each finding. Replace accidental ambient access with an explicit service. Add a category-specific suppression only when the call implements an intentional effect boundary.

After resolving the initial findings, configure the analyzer to fail the build on new findings:

<PropertyGroup>
  <AxialGuardrailsSeverity>error</AxialGuardrailsSeverity>
</PropertyGroup>

To disable the analyzer for one project without removing the package, set AxialGuardrailsEnabled to false.

See Effect-boundary guardrails for the diagnostic list, configuration options, and suppression syntax.

Go further

  • Hosting chooses between standalone .NET, Generic Host, Node, and browser entry points.
  • Platform services introduces the explicit clock, logging, random, GUID, and environment-variable contracts.
  • Effect-boundary guardrails is the analyzer that enforces those contracts as a build check instead of a review convention.