Getting Started

Installation

Add Zeeq Biome to a .NET 10 test project.

Biome can work with the test framework you already use. Start with the core package; add the EF Core integration if your tests need to persist the graph.

Requirements

  • .NET 10. Use C# 14 if you write handwritten context overloads or scenario helpers with extension blocks; generated graft methods use regular extension methods.
  • Any test framework. The examples use TUnit.
  • The core package has no dependencies.

Add the packages

dotnet add package Zeeq.Biome
# Optional: save with a DbContext
dotnet add package Zeeq.Biome.EntityFrameworkCore
Only add Zeeq.Biome.EntityFrameworkCore when you want to save through a DbContext. For pure unit tests, the core package alone is enough.

Input blueprint API version

Ordinary entity outputs for Blueprint.FromInput, and Blueprint.ChildFromInput, are available in Zeeq.Biome 1.1.0 and later. If you also use Zeeq.Biome.EntityFrameworkCore, use the matching package version. See Input blueprints for their behavior.

Namespaces

Usings.cs
// Biome, Blueprint, Sequence, BiomeOptions, IBiomeStore, …
using Zeeq.Biome;
using Zeeq.Biome.EntityFrameworkCore;   // EfCoreStore, db.AsBiomeStore()

Verify the install

To check the install before defining your app's blueprints, start a small session in a test. This example needs no store:

InstallTests.cs
public sealed class InstallTests
{
    [Test]
    public async Task Biome_starts()
    {
        var biome = Biome.Start("seed", new BiomeOptions<string>());
        await biome.BuildAsync(); // NullStore: nothing is saved
    }
}
The minimal install above starts a session with a plain string as the seed. The Quick start replaces it with a real seed and your own TestBiome.

Local builds

Packages built from a clone report 0.0.0-local. Releases are versioned with Semantic Versioning, computed from Conventional Commits (feat: is a minor bump, fix: a patch, feat!: a major).