Skip to main content

Overview

The Flinkwerk Command Line Interface is a unified tool to manage your Flinkwerk projects and products.

Setup​

Please apply for the Beta Preview to gain access to Flinkwerk CLI.

Synopsis​

The flinkwerk CLI commands below are used to develop, deploy and distribute on the Flinkwerk platform.

flinkwerk auth                   # Authenticate with the Flinkwerk API.
flinkwerk build                  # Build a container image.
flinkwerk cluster [SUBCOMMAND]   # Manage project clusters.
flinkwerk deploy                 # Deploy clusters and apps.
flinkwerk distribute             # Release project as a product in Flinkwerk Marketplace.
flinkwerk help [COMMAND]         # Describe available commands or one specific command.
flinkwerk project [SUBCOMMAND]   # Manage your project.
flinkwerk version                # Show Flinkwerk CLI application version.

Available commands​

auth​

Authenticate with the Flinkwerk API.

flinkwerk auth

build​

Build a container image.

flinkwerk build

Options​

-p, [--push]                     # Perform a `push` after a successful build.
-x, [--buildx]                   # Enable multi-arch build.

cluster​

Manage project clusters.

  flinkwerk cluster

See the related subcommands.

deploy​

Deploy clusters and apps.

  flinkwerk deploy

Options​

-b, [--branch=<branch-name>]     # Perform the action on a specific branch.

distribute​

Release project as a product in Flinkwerk Marketplace.

flinkwerk distribute

Options​

-i, [--increment=<major|minor>]  # Specifies the increment type.
                                 # Possible values: major, minor

init​

Initialize the Flinkwerk configuration for a project.

Create the Flinkwerk Config file and other necessary resources for the project.

flinkwerk init

Options​

--owner=<owner>              # Your account name.
--name=<name>                # Project name.

project​

Manage your Flinkwerk project.

flinkwerk project

See the related subcommands.

version​

Show Flinkwerk CLI application version.

flinkwerk version

Global options​

These global options have the same behavior across all commands and affect how Flinkwerk CLI interacts with Flinkwerk platform.

-v, [--verbose]                  # Show detailed output.
-w, [--workdir=<path>]           # Set the workdir path. Defaults to '.'