Setup Flox #
Install and verify Flox, then optionally install versioned packages for a CI/CD pipeline. Implemented as a typed PureScript Wasm component for FluentCI v0.17.2+.
fluentci run setup-flox setup --version latest \
--packages nodejs@22.14.0,python3@3.12.9 --project .
fluentci run setup-flox setup --help
version selects the Flox release. packages is an optional comma-separated string of
native package selectors, each carrying its own version. Omitting it or passing
a blank value installs only the manager and preserves the existing behavior.
Whitespace around selectors is trimmed; empty entries between commas are rejected.
Package/version availability depends on the manager’s registry and platform;
missing versions and failed installs fail the setup call.
packages accepts Flox catalog selectors such as nodejs@22 or
python3@3.12.9. project selects an existing directory (default .). Setup
initializes an empty fluentci environment if .flox is absent, without automatic
language detection, then installs the requested packages. Existing environments
are reused and their other packages are retained. This updates the local Flox
manifest and lockfile; preserve them for reproducibility.
Setup exports the activated executable PATH without starting services. Activation
may run the project’s native hooks; use trusted environment definitions. Use
flox activate --dir PROJECT -- CMD when a command needs the complete native
activation environment, hooks, or shell state.
Package environments support Linux/macOS. CLI-only BSD setup still uses native
repositories when available; supplying packages on BSD fails before mutation.
The Flox CLI uses native packages: macOS needs the official Homebrew formula,
and Linux needs a configured repository providing Flox or an existing official
installation. Requested CLI releases must be available in that source.
The return type remains tool, version, bin-dir, and environment (a list
of {name, value} records). bin-dir identifies the manager; use the returned
environment PATH to include requested package executables. Updates apply to
later tasks in the same host session. Separate processes must propagate the
returned environment. No successful environment is published if installation or
environment discovery fails; already installed files or project updates may remain.
For upstream archive installations, install-dir selects an absolute per-user
manager prefix. Native packages use the system prefix; omit install-dir, use
package-name for a native manager package selector, and sudo when needed.
These manager installation options do not change package versions in packages.
See COMPONENT.md for every typed argument and return, upstream package syntax, and MIT License.
Compose this module from code #
Requires FluentCI 0.17.6 or newer for generated pipeline bindings. From your caller module's directory, add the dependency:
fluentci add setup-flox --path /path/to/fluentci-modules/setup/flox
For a published module, use fluentci add @fluentci.io/setup-flox@VERSION with an
available version. Commit the caller's manifest and lockfile. FluentCI generates
named bindings from the installed component's WIT; no handwritten FFI or CLI
subprocess is needed. Include generated source directories in the caller's SDK
project. The callee can use a different SDK from the caller.
Provision flox before the build steps that require it. The setup result reports the installed version and executable directory.
Replace the sample organization, paths and identifiers with your own. Configure credentials through your CI secret provider before running authenticated operations. Optional arguments use the callee's defaults, and public list fields use comma-separated strings. See COMPONENT.md for argument descriptions and return types.
These examples use the generated composition API and builder chaining in FluentCI 0.17.6; full cross-SDK compilation and execution coverage is still pending. See composition support and limitations.
PureScript #
module Main where
import Prelude
import Effect (Effect)
import FluentCI.Flow as Flow
import FluentCI.Modules.SetupFlox as SetupFlox
run :: Effect String
run =
Flow.pipeline "setup-flox-setup"
# Flow.workdir "."
# SetupFlox.setup (SetupFlox.setupArgs)
# Flow.map (\result -> result.version)
# Flow.run
Gleam #
import fluentci/flow
import fluentci_modules/setup_flox
pub fn run() -> String {
flow.pipeline("setup-flox-setup")
|> flow.workdir(".")
|> setup_flox.setup(setup_flox.setup_args())
|> flow.map(fn(result) { result.version })
|> flow.run
}
Use Gleam's JavaScript target for the Wasm guest. BEAM escripts used for repository automation are separate from component guests.
Elixir #
defmodule Main do
use FluentCI.Plugin
alias FluentCI.Flow
alias FluentCI.Modules.SetupFlox
defplugin run do
Flow.pipeline("setup-flox-setup")
|> Flow.workdir(".")
|> SetupFlox.setup(%{})
|> Flow.stdout()
end
end
Elixir compiles this sequence to Rust/Wasm. Its initial Flow API does not yet provide the typed result callbacks or cleanup combinators of the other examples.
ClojureScript #
(ns main.plugin
(:require [fluentci.flow :as flow]
[fluentci-modules.setup-flox :as setup_flox]))
(defn run []
(-> (flow/pipeline "setup-flox-setup")
(flow/workdir ".")
(setup_flox/setup {})
flow/run!))
ReScript #
let run = (): string =>
Flow.pipeline("setup-flox-setup")
->Flow.workdir(".")
->FluentciModulesSetupFlox.setup(FluentciModulesSetupFlox.setupArgs)
->Flow.map(result => result.version)
->Flow.run
Python #
from fluentci.flow import pipeline
from fluentci_modules import setup_flox
def run() -> str:
return (
pipeline("setup-flox-setup")
.workdir(".")
.pipe(setup_flox.setup, {})
.map(lambda result: result.version)
.run()
)
TypeScript #
import * as flow from "./fluentci_modules/flow";
import * as setup_flox from "./fluentci_modules/setup-flox/index";
export function run(): string {
return flow.pipeline("setup-flox-setup")
.workdir(".")
.pipe(setup_flox.setup, {})
.map(result => result.version)
.run();
}
Python and TypeScript use FluentCI builder chains: .pipe(module.function, args)
composes generated module functions with .workdir, .env, and .exec.
Functions return a pipeline carrying their typed result. Use a generated result
callback (With/_with, or a callback argument in TypeScript/Python) when a later
module needs a preceding result; use Flow's map operation to select a result field.
Execution begins at run (or the Elixir plugin terminal), in declared order.
Exported functions #
| Function | Purpose |
|---|---|
setup |
Install and verify flox, select its version, and publish its environment for subsequent tasks. |