For the complete documentation index, see llms.txt. This page is also available as Markdown.

Author Workflows

Install the Pipekit CLI and submit your first workflow against a connected cluster.

A 5-minute path for workflow authors joining a Pipekit Organization that's already set up.

If you don't have a Pipekit account yet, follow Evaluate Pipekit Cloud instead. If you're the platform engineer setting Pipekit up for a team, follow Operate Pipekit.

Prerequisites

  • A Pipekit account in an existing Organization, invited by an Org Admin.

  • The name of a Cluster you have access to (ask your admin).

  • A computer running macOS, Linux, or Windows.

1. Install the CLI

# macOS / Linux (Homebrew)
brew install pipekit/tap/cli

# Windows (Scoop)
scoop bucket add pipekit https://github.com/pipekit/scoop.git
scoop install pipekit/cli

For NixOS, Docker, and binary downloads, see Reference > CLI > Install.

2. Log in

If your Organization has SSO configured, the CLI redirects you to your identity provider. Otherwise enter your Pipekit username and password. The CLI stores your access token at ~/.pipekit/token.

3. List the clusters you can submit to

This confirms which clusters your account has access to. Note the CLUSTER NAME you'll use in the next step.

4. Submit a workflow

Clone the Pipekit Examples repo and submit a sample workflow:

The CLI prints a link to the Run in the Pipekit UI.

5. View the Run

Open the link from step 4 (or browse to https://pipekit.io/pipes).

You'll see:

What's next

  • Submit your own workflows: point pipekit submit at any Argo Workflow YAML.

  • Stop, terminate, or restart Runs: see CLI > Run Actions or do it from the UI.

  • Submit from Python with Hera: see Reference > Python SDK.

  • Author CronWorkflows: see Cron.

  • Use an AI agent to debug failed Runs or author new workflows. See AI.

Best practice

Set namespace and serviceAccountName on every workflow you submit. If you omit them, Pipekit submits to the cluster's default namespace and default service account, which usually lack the permissions Argo needs. Ask your platform engineer what namespace and service account your team is supposed to use.

Last updated