flyway CLI reference

ModularPipelines.Flyway provides strongly typed access to the flyway CLI.

Executable prerequisite

This package does not install the flyway executable. Install it separately and ensure flyway is available on PATH.

Follow the executable's official documentation for installation instructions.

Package installation

dotnet add package ModularPipelines.Flyway

Resolve the service with context.Tools.Flyway. Projects using C# 13 or another .NET language can use context.Tools.Get<ModularPipelines.Flyway.Services.IFlyway>() instead.

Module example

Resolve the service in a module, then select a command from the table below. A runnable example is omitted when no command has complete safety metadata:

var flyway = context.Tools.Flyway;

Commands

CLI command	Options record
flyway add	FlywayAddOptions
flyway auth	FlywayAuthOptions
flyway baseline	FlywayBaselineOptions
flyway check	FlywayCheckOptions
flyway clean	FlywayCleanOptions
flyway deploy	FlywayDeployOptions
flyway diff	FlywayDiffOptions
flyway diffApply	FlywayDiffApplyOptions
flyway diffText	FlywayDiffTextOptions
flyway generate	FlywayGenerateOptions
flyway info	FlywayInfoOptions
flyway init	FlywayInitOptions
flyway list-engines	FlywayListEnginesOptions
flyway migrate	FlywayMigrateOptions
flyway prepare	FlywayPrepareOptions
flyway repair	FlywayRepairOptions
flyway snapshot	FlywaySnapshotOptions
flyway undo	FlywayUndoOptions
flyway validate	FlywayValidateOptions