Skip to main content

Getting Started

Lorem ipsum dolor sit amet, consectetur adipiscing elit. This guide walks you through installing the Flux CLI, authenticating against your workspace, and running your first pipeline end-to-end.

Prerequisites​

You will need:

  • Node.js 18+ or .NET 8 SDK (depending on which runtime you use)
  • A Flux workspace token – grab one from the admin UI under Settings → Tokens
  • Read/write access to the target sink (Kafka, Postgres, S3, etc.)

Install the CLI​

# npm
npm install -g @flux/cli

# pnpm
pnpm add -g @flux/cli

# Homebrew
brew install commercemind/tap/flux

Verify the install:

$ flux --version
flux 1.4.2

Authenticate​

flux login --workspace acme
# Opens a browser; once approved, the token is written to ~/.flux/config.toml

Run your first pipeline​

Create hello.flux.ts:

import { pipeline, step } from '@flux/core';

export default pipeline('hello-world')
  .step(
    step('greet').run(async (ctx) => {
      ctx.log.info('Hello from Flux!');
      return { message: 'ok' };
    }),
  );

Then execute it:

flux run hello.flux.ts

You should see:

[info]  hello-world :: started  (run-id 01J8...)
[info]  hello-world.greet :: Hello from Flux!
[info]  hello-world :: completed in 124ms

Next steps​