flux CLI reference

ModularPipelines.Flux provides strongly typed access to the flux CLI.

Executable prerequisite

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

Follow the executable's official documentation for installation instructions.

Package installation

dotnet add package ModularPipelines.Flux

Resolve the service with context.Tools.Flux. Projects using C# 13 or another .NET language can use context.Tools.Get<ModularPipelines.Flux.Services.IFlux>() 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 flux = context.Tools.Flux;

Global options

Global options are rendered after the selected subcommand.

CLI option	Property	Availability	Description
`--as`	`As`	All editions	Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
`--as-group`	`AsGroup`	All editions	Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
`--as-uid`	`AsUid`	All editions	UID to impersonate for the operation.
`--as-user-extra`	`AsUserExtra`	All editions	User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
`--cache-dir`	`CacheDir`	All editions	Default cache directory.
`--certificate-authority`	`CertificateAuthority`	All editions	Path to a cert file for the certificate authority to authenticate the Kubernetes API server
`--client-certificate`	`ClientCertificate`	All editions	Path to a client certificate file for TLS authentication to the Kubernetes API server
`--client-key`	`ClientKey`	All editions	Path to a client key file for TLS authentication to the Kubernetes API server
`--cluster`	`Cluster`	All editions	The name of the kubeconfig cluster to use
`--context`	`Context`	All editions	The name of the kubeconfig context to use
`--disable-compression`	`DisableCompression`	All editions	If true, opt-out of response compression for all requests to the server
`--insecure-skip-tls-verify`	`InsecureSkipTlsVerify`	All editions	If true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure
`--kube-api-burst`	`KubeApiBurst`	All editions	The maximum burst queries-per-second of requests sent to the Kubernetes API. (default 300)
`--kube-api-qps`	`KubeApiQps`	All editions	The maximum queries-per-second of requests sent to the Kubernetes API. (default 50)
`--kubeconfig`	`KubeConfig`	All editions	Path to the kubeconfig file to use for CLI requests.
`--namespace`	`Namespace`	All editions	If present, the namespace scope for this CLI request (default "flux-system")
`--ns-follows-kube-context`	`NsFollowsKubeContext`	All editions	use the namespace from the kubeconfig context instead of the default flux-system namespace, can also be set via FLUX_NS_FOLLOWS_KUBE_CONTEXT env var
`--server`	`Server`	All editions	The address and port of the Kubernetes API server
`--timeout`	`Timeout`	All editions	timeout for this operation (default 5m0s)
`--tls-server-name`	`TlsServerName`	All editions	Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
`--token`	`Token`	All editions	Bearer token for authentication to the API server
`--user`	`User`	All editions	The name of the kubeconfig user to use
`--verbose`	`Verbose`	All editions	print generated objects

Commands

CLI command	Options record
`flux bootstrap`	`FluxBootstrapOptions`
`flux bootstrap bitbucket-server`	`FluxBootstrapBitbucketServerOptions`
`flux bootstrap git`	`FluxBootstrapGitOptions`
`flux bootstrap gitea`	`FluxBootstrapGiteaOptions`
`flux bootstrap github`	`FluxBootstrapGithubOptions`
`flux bootstrap gitlab`	`FluxBootstrapGitlabOptions`
`flux build`	`FluxBuildOptions`
`flux build artifact`	`FluxBuildArtifactOptions`
`flux build kustomization`	`FluxBuildKustomizationOptions`
`flux check`	`FluxCheckOptions`
`flux create`	`FluxCreateOptions`
`flux create alert`	`FluxCreateAlertOptions`
`flux create alert-provider`	`FluxCreateAlertProviderOptions`
`flux create helmrelease`	`FluxCreateHelmreleaseOptions`
`flux create image`	`FluxCreateImageOptions`
`flux create image policy`	`FluxCreateImagePolicyOptions`
`flux create image repository`	`FluxCreateImageRepositoryOptions`
`flux create image update`	`FluxCreateImageUpdateOptions`
`flux create kustomization`	`FluxCreateKustomizationOptions`
`flux create receiver`	`FluxCreateReceiverOptions`
`flux create secret`	`FluxCreateSecretOptions`
`flux create secret git`	`FluxCreateSecretGitOptions`
`flux create secret githubapp`	`FluxCreateSecretGithubappOptions`
`flux create secret helm`	`FluxCreateSecretHelmOptions`
`flux create secret notation`	`FluxCreateSecretNotationOptions`
`flux create secret oci`	`FluxCreateSecretOciOptions`
`flux create secret proxy`	`FluxCreateSecretProxyOptions`
`flux create secret receiver`	`FluxCreateSecretReceiverOptions`
`flux create secret tls`	`FluxCreateSecretTlsOptions`
`flux create source`	`FluxCreateSourceOptions`
`flux create source bucket`	`FluxCreateSourceBucketOptions`
`flux create source chart`	`FluxCreateSourceChartOptions`
`flux create source git`	`FluxCreateSourceGitOptions`
`flux create source helm`	`FluxCreateSourceHelmOptions`
`flux create source oci`	`FluxCreateSourceOciOptions`
`flux create tenant`	`FluxCreateTenantOptions`
`flux debug`	`FluxDebugOptions`
`flux debug helmrelease`	`FluxDebugHelmreleaseOptions`
`flux debug kustomization`	`FluxDebugKustomizationOptions`
`flux delete`	`FluxDeleteOptions`
`flux delete alert`	`FluxDeleteAlertOptions`
`flux delete alert-provider`	`FluxDeleteAlertProviderOptions`
`flux delete helmrelease`	`FluxDeleteHelmreleaseOptions`
`flux delete image`	`FluxDeleteImageOptions`
`flux delete image policy`	`FluxDeleteImagePolicyOptions`
`flux delete image repository`	`FluxDeleteImageRepositoryOptions`
`flux delete image update`	`FluxDeleteImageUpdateOptions`
`flux delete kustomization`	`FluxDeleteKustomizationOptions`
`flux delete receiver`	`FluxDeleteReceiverOptions`
`flux delete source`	`FluxDeleteSourceOptions`
`flux delete source bucket`	`FluxDeleteSourceBucketOptions`
`flux delete source chart`	`FluxDeleteSourceChartOptions`
`flux delete source git`	`FluxDeleteSourceGitOptions`
`flux delete source helm`	`FluxDeleteSourceHelmOptions`
`flux delete source oci`	`FluxDeleteSourceOciOptions`
`flux diff`	`FluxDiffOptions`
`flux diff artifact`	`FluxDiffArtifactOptions`
`flux diff kustomization`	`FluxDiffKustomizationOptions`
`flux envsubst`	`FluxEnvsubstOptions`
`flux events`	`FluxEventsOptions`
`flux export`	`FluxExportOptions`
`flux export alert`	`FluxExportAlertOptions`
`flux export alert-provider`	`FluxExportAlertProviderOptions`
`flux export artifact`	`FluxExportArtifactOptions`
`flux export artifact generator`	`FluxExportArtifactGeneratorOptions`
`flux export helmrelease`	`FluxExportHelmreleaseOptions`
`flux export image`	`FluxExportImageOptions`
`flux export image policy`	`FluxExportImagePolicyOptions`
`flux export image repository`	`FluxExportImageRepositoryOptions`
`flux export image update`	`FluxExportImageUpdateOptions`
`flux export kustomization`	`FluxExportKustomizationOptions`
`flux export receiver`	`FluxExportReceiverOptions`
`flux export source`	`FluxExportSourceOptions`
`flux export source bucket`	`FluxExportSourceBucketOptions`
`flux export source chart`	`FluxExportSourceChartOptions`
`flux export source external`	`FluxExportSourceExternalOptions`
`flux export source git`	`FluxExportSourceGitOptions`
`flux export source helm`	`FluxExportSourceHelmOptions`
`flux export source oci`	`FluxExportSourceOciOptions`
`flux get`	`FluxGetOptions`
`flux get alert-providers`	`FluxGetAlertProvidersOptions`
`flux get alerts`	`FluxGetAlertsOptions`
`flux get all`	`FluxGetAllOptions`
`flux get artifacts`	`FluxGetArtifactsOptions`
`flux get artifacts generators`	`FluxGetArtifactsGeneratorsOptions`
`flux get helmreleases`	`FluxGetHelmreleasesOptions`
`flux get images`	`FluxGetImagesOptions`
`flux get images all`	`FluxGetImagesAllOptions`
`flux get images policy`	`FluxGetImagesPolicyOptions`
`flux get images repository`	`FluxGetImagesRepositoryOptions`
`flux get images update`	`FluxGetImagesUpdateOptions`
`flux get kustomizations`	`FluxGetKustomizationsOptions`
`flux get receivers`	`FluxGetReceiversOptions`
`flux get sources`	`FluxGetSourcesOptions`
`flux get sources all`	`FluxGetSourcesAllOptions`
`flux get sources bucket`	`FluxGetSourcesBucketOptions`
`flux get sources chart`	`FluxGetSourcesChartOptions`
`flux get sources external`	`FluxGetSourcesExternalOptions`
`flux get sources git`	`FluxGetSourcesGitOptions`
`flux get sources helm`	`FluxGetSourcesHelmOptions`
`flux get sources oci`	`FluxGetSourcesOciOptions`
`flux install`	`FluxInstallOptions`
`flux list`	`FluxListOptions`
`flux list artifacts`	`FluxListArtifactsOptions`
`flux logs`	`FluxLogsOptions`
`flux migrate`	`FluxMigrateOptions`
`flux plugin`	`FluxPluginOptions`
`flux plugin install`	`FluxPluginInstallOptions`
`flux plugin list`	`FluxPluginListOptions`
`flux plugin search`	`FluxPluginSearchOptions`
`flux plugin uninstall`	`FluxPluginUninstallOptions`
`flux plugin update`	`FluxPluginUpdateOptions`
`flux pull`	`FluxPullOptions`
`flux pull artifact`	`FluxPullArtifactOptions`
`flux push`	`FluxPushOptions`
`flux push artifact`	`FluxPushArtifactOptions`
`flux reconcile`	`FluxReconcileOptions`
`flux reconcile helmrelease`	`FluxReconcileHelmreleaseOptions`
`flux reconcile image`	`FluxReconcileImageOptions`
`flux reconcile image policy`	`FluxReconcileImagePolicyOptions`
`flux reconcile image repository`	`FluxReconcileImageRepositoryOptions`
`flux reconcile image update`	`FluxReconcileImageUpdateOptions`
`flux reconcile kustomization`	`FluxReconcileKustomizationOptions`
`flux reconcile receiver`	`FluxReconcileReceiverOptions`
`flux reconcile source`	`FluxReconcileSourceOptions`
`flux reconcile source bucket`	`FluxReconcileSourceBucketOptions`
`flux reconcile source chart`	`FluxReconcileSourceChartOptions`
`flux reconcile source git`	`FluxReconcileSourceGitOptions`
`flux reconcile source helm`	`FluxReconcileSourceHelmOptions`
`flux reconcile source oci`	`FluxReconcileSourceOciOptions`
`flux resume`	`FluxResumeOptions`
`flux resume alert`	`FluxResumeAlertOptions`
`flux resume alert-provider`	`FluxResumeAlertProviderOptions`
`flux resume helmrelease`	`FluxResumeHelmreleaseOptions`
`flux resume image`	`FluxResumeImageOptions`
`flux resume image policy`	`FluxResumeImagePolicyOptions`
`flux resume image repository`	`FluxResumeImageRepositoryOptions`
`flux resume image update`	`FluxResumeImageUpdateOptions`
`flux resume kustomization`	`FluxResumeKustomizationOptions`
`flux resume receiver`	`FluxResumeReceiverOptions`
`flux resume source`	`FluxResumeSourceOptions`
`flux resume source bucket`	`FluxResumeSourceBucketOptions`
`flux resume source chart`	`FluxResumeSourceChartOptions`
`flux resume source git`	`FluxResumeSourceGitOptions`
`flux resume source helm`	`FluxResumeSourceHelmOptions`
`flux resume source oci`	`FluxResumeSourceOciOptions`
`flux stats`	`FluxStatsOptions`
`flux suspend`	`FluxSuspendOptions`
`flux suspend alert`	`FluxSuspendAlertOptions`
`flux suspend alert-provider`	`FluxSuspendAlertProviderOptions`
`flux suspend helmrelease`	`FluxSuspendHelmreleaseOptions`
`flux suspend image`	`FluxSuspendImageOptions`
`flux suspend image policy`	`FluxSuspendImagePolicyOptions`
`flux suspend image repository`	`FluxSuspendImageRepositoryOptions`
`flux suspend image update`	`FluxSuspendImageUpdateOptions`
`flux suspend kustomization`	`FluxSuspendKustomizationOptions`
`flux suspend receiver`	`FluxSuspendReceiverOptions`
`flux suspend source`	`FluxSuspendSourceOptions`
`flux suspend source bucket`	`FluxSuspendSourceBucketOptions`
`flux suspend source chart`	`FluxSuspendSourceChartOptions`
`flux suspend source git`	`FluxSuspendSourceGitOptions`
`flux suspend source helm`	`FluxSuspendSourceHelmOptions`
`flux suspend source oci`	`FluxSuspendSourceOciOptions`
`flux tag`	`FluxTagOptions`
`flux tag artifact`	`FluxTagArtifactOptions`
`flux trace`	`FluxTraceOptions`
`flux tree`	`FluxTreeOptions`
`flux tree artifact`	`FluxTreeArtifactOptions`
`flux tree artifact generator`	`FluxTreeArtifactGeneratorOptions`
`flux tree kustomization`	`FluxTreeKustomizationOptions`
`flux trigger`	`FluxTriggerOptions`
`flux trigger receiver`	`FluxTriggerReceiverOptions`
`flux uninstall`	`FluxUninstallOptions`
`flux version`	`FluxVersionOptions`

Executable prerequisite​

Package installation​

Module example​

Global options​

Commands​

Executable prerequisite

Package installation

Module example

Global options

Commands