FluentCI Engine

If you love FluentCI, please ★ star this repository to show your support 💚. Looking for support? Join our Discord.

FluentCI Engine is a programmable CI/CD engine (used by FluentCI) that is designed to be simple, flexible, and easy to use. It is supposed to run on the host machine without containerization or virtualization, and it is designed to be used with Nix, Pkgx, Devbox, Flox, Devenv, Hermit, EnvHub, Pixi and Mise.

Note

Project Status: 🐲 Unstable, alpha-ish quality. This project is still in the early stages of development, and it is not yet ready for production use. It is not feature-complete, and it is not yet stable. Use at your own risk.

✨ Features

• Simple and easy to use
• Flexible
• No containerization or virtualization
• Built-in support for Nix, Hermit, Pkgx, Devbox, Flox, Devenv, Envhub, Mise and Pixi
• Built-in support for Secrets (backends: Google Secret Manager, AWS Secrets Manager, Azure Key Vault and HashiCorp Vault)
• Built-in support for Services
• Cache support (backends: local, S3, GCS, R2)
• SDK for writing pipelines in TypeScript, Gleam, Rescript and Purescript, see @fluentci/sdk
• GraphQL API, see API Documentation
• OpenTelemetry tracing
• Plugin system in WebAssembly, see examples

🚀 Quick Start

# Clone the repository
git clone https://github.com/fluentci-io/fluentci-engine.git
# Go to the project directory
cd fluentci-engine
# Install dependencies
nix develop
cargo run -p fluentci-engine -- serve
# Open the browser and go to http://localhost:6880/graphiql
# See ./fixtures for some GraphQL queries examples

Tip

Quickly setup Nix on your machine with DeterminateSystems Nix installer

📦 Downloads

• Mac: arm64: fluentci-engine_v0.4.11_aarch64-apple-darwin.tar.gz intel: fluentci-engine_v0.4.11_x86_64-apple-darwin.tar.gz
• Linux: intel: fluentci-engine_v0.4.11_x86_64-unknown-linux-gnu.tar.gz arm64: fluentci-engine_v0.4.11_aarch64-unknown-linux-gnu.tar.gz

📚 Documentation

• API Documentation

🧩 Plugins

FluentCI Engine supports plugins in WebAssembly. You can write your own plugins in Rust or any other language that can compile to WebAssembly. See examples for more information.

🦀 Rust Plugin Example

Create a new Rust project:

cargo new nix --lib

Install the extism_pdk, fluentci_types and fluentci_pdk crates:

cargo add extism_pdk fluentci_types fluentci_pdk

Save the following code to src/lib.rs:

use extism_pdk::*;
use fluentci_pdk::dag;
use fluentci_types::nix::NixArgs;

#[plugin_fn]
pub fn exec(command: String) -> FnResult<String> {
    let stdout = dag()
        .nix(NixArgs {
            impure: true
        })?
        .with_exec(command.split_whitespace().collect())?
        .stdout()?;
    Ok(stdout)
}

Set the following in your Cargo.toml:

[lib]
crate-type = ["cdylib"]

Compile the plugin to WebAssembly:

cargo build --release --target wasm32-unknown-unknown

Run the plugin:

fluentci-engine call -m ./target/wasm32-unknown-unknown/release/nix.wasm -- exec nix --version

📑 Available Plugins

• android
• ansible-lint
• ansible
• apko
• atlas
• base
• bazel
• biome
• black
• buf
• buildx
• bun
• checkmake
• chromatic
• clojure
• cloudflare
• codecov
• cue
• cypress
• dagger
• deno
• depot
• dotnet
• elixir
• fastlane
• firebase
• flakestry
• flipt
• fly
• flutter
• github
• gleam
• go
• gradle
• grype
• heroku
• microcks
• netlify
• nixpacks
• nodejs
• pkl
• playwright
• pulumi
• oxc
• railway
• ruby
• ruff
• rust
• rye
• shuttle
• sonar
• spin
• ssh
• supabase
• syft
• symfony
• terraform
• zig
• wasmer

🌈 Builtin functions

FluentCI Plugin Development Kit (fluentci_pdk) provides some builtin functions from that you can use in your plugins:

devbox

Setup a Devbox Environment.

Example:

dag()
  .devbox()?
  .with_exec(vec!["devbox", "version"])?
  .stdout()?;

devenv

Setup a Devenv Environment.

Example:

dag()
  .devenv()?
  .with_exec(vec!["devenv", "version"])?
  .stdout()?;

directory

Load a directory at the given path.

Example:

dag()
  .directory(".")?
  .with_exec(vec!["ls", "-la"])?
  .stdout()?;

envhub

Setup an EnvHub Environment.

Example:

dag()
  .envhub()?
  .with_exec(vec!["envhub", "--version"])?
  .stdout()?;

file

Load a file at the given path.

Example:

dag()
  .file("Cargo.toml")?
  .path()?;

flox

Setup a Flox Environment.

Example:

dag()
  .flox()?
  .with_exec(vec!["flox", "--version"])?
  .stdout()?;

git

Load a Git repository at the given URL.

Example:

dag()
  .git("https://github.com/tsirysndr/me")?
  .branch("main")?
  .tree()?
  .entries()?;

http

Load a HTTP resource at the given URL.

Example:

dag()
  .http("https://example.com")?
  .path()?;

mise

Setup a Mise Environment.

Example:

dag()
  .mise()?
  .with_exec(vec!["mise", "--version"])?
  .stdout()?;

nix

Setup a Nix Environment.

Example:

dag()
  .nix(NixArgs {
    impure: true
  })?
  .with_exec(vec!["nix", "--version"])?
  .stdout()?;

pipeline

Create a new pipeline.

Example:

dag()
  .pipeline("example")?
  .with_exec(vec!["echo", "Hello, World!"])?
  .stdout()?;

pixi

Setup a Pixi Environment.

Example:

dag()
  .pixi()?
  .with_exec(vec!["pixi", "--version"])?
  .stdout()?;

pkgx

Setup a Pkgx Environment.

Example:

dag()
  .pkgx()?
  .with_exec(vec!["pkgx", "--version"])?
  .stdout()?;

🌱 Github Actions

FluentCI Engine is designed to be used with Github Actions. You can use the fluentci-io/setup-fluentci@v5 action to run your pipelines. See fluentci-io/setup-fluentci for more information.

name: Hello

on:
  push:
    branches:
      - main

jobs:
  setup-fluentci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Setup FluentCI
        uses: fluentci-io/setup-fluentci@v5
        with:
          wasm: true # set to true so WebAssembly plugins can be used
          plugin: base # Name of the Wasm Plugin to use without the .wasm extension, 
          # will be downloaded from the registry https://pkg.fluentci.io

          # Arguments to pass to the plugin: function_name args
          args: |
            hello Hello, World!

⚡ Caching

FluentCI Engine supports caching. To enable it, set the following environment variables:

• FLUENTCI_CACHE_GCS_BUCKET - GCS bucket name, if you are using Google Cloud Storage
• FLUENTCI_CACHE_S3_ENDPOINT - S3 endpoint, if you are using S3-compatible storage
• FLUENTCI_CACHE_S3_BUCKET - S3 bucket name, if you are using S3-compatible storage
• FLUENTCI_CACHE_CDN_ENDPOINT - CDN endpoint, if you are using CDN (optional) for downloading cache

Note

You need to set GOOGLE_APPLICATION_CREDENTIALS or AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables to use GCS or S3 cache.

🔭 OpenTelemetry Tracing

FluentCI Engine supports OpenTelemetry tracing. To enable it, set the OTEL_EXPORTER_OTLP_ENDPOINT or OTEL_EXPORTER_ZIPKIN_ENDPOINT (if you want to use Zipkin) environment variable to the desired endpoint.

📑 Logging

FluentCI Engine supports sending logs to Baselime. To enable it, set the BASELIME_API_KEY environment variable to the desired API key.