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

Commands

The Pipekit CLI's core commands: login, submit, get run, list, stop/terminate/restart, logs, update cluster, import workflows.

Every command listed here is also doable via the REST API, the Python SDK, and the UI. For the MCP Server (LLM client integration), see AI > Setup.

Log in

pipekit login

You'll be prompted to pick either username/password or SSO, depending on how your account was created. After login, the CLI stores your access token at ~/.pipekit/token (override via PIPEKIT_CONFIG_DIR).

For non-interactive login (CI, containers), see Advanced > Non-interactive login.

Submit a workflow

pipekit submit --cluster-name=<cluster> --namespace=<ns> path/to/workflow.yaml

If no Pipe with the workflow's generateName exists on the cluster, Pipekit creates one. Subsequent submissions of the same workflow add new Runs to the existing Pipe. For the Pipe / Run model, see Concepts > Workflow vs Pipe vs Run.

Flag
Shorthand
Type
Description

--namespace

-n

string

Name of the namespace to submit the workflow to.

--cluster-name

-c

string

Name of the cluster to submit the workflow to. Required.

--open-ui

bool

Open the UI for the submitted workflow.

--parameter

-p

stringArray (key=value)

Pass input parameter(s).

--wait

-w

bool

Wait for the submitted workflow to complete.

--pipe-name

-d

string

Name of the Pipe to submit the workflow to.

--json

bool

Output the run details in JSON format.

Get information about a Run

You can also look up a Run by (cluster, namespace, workflow-name):

If multiple Runs match, the latest one is returned.

Flag
Shorthand
Type
Description

--run-uuid

-r

string

Run UUID of the workflow you want to get.

--cluster-name

-c

string

Name of the cluster where the workflow is located.

--namespace

-n

string

Kubernetes namespace where the workflow is/was running.

--workflow-name

-w

string

Name of the workflow.

List clusters, Pipes, and Runs

List clusters

List Pipes

Flag
Shorthand
Type
Description

--all

-A

bool

Get all Pipes, both enabled and disabled.

--cluster-name

-c

string

Name of the cluster to list from. Required.

--enabled

bool

Enabled/disabled switch (default true).

List Runs

Flag
Shorthand
Type
Description

--cluster-name

-c

string

Name of the cluster to list from.

--all

-A

bool

Get all Runs, regardless of status.

--statuses

-s

stringArray

Get Runs with a given status (defaults to running).

Run actions: stop, terminate, restart

stop and terminate take the same flag:

Flag
Shorthand
Type
Description

--run-uuid

-r

string

Run UUID of the running workflow you want to stop/terminate. Required.

restart takes:

Flag
Shorthand
Type
Description

--run-uuid

-r

string

Run UUID of the run you want to restart. Required.

--open-ui

bool

Open the UI of the resubmitted workflow.

--wait

-w

bool

Wait for the workflow to complete.

View pod logs

Filter by pod and container name; follow the stream to tail logs as they're produced.

Flag
Shorthand
Type
Description

--run-uuid

-r

string

UUID of the Run. Required.

--container

-c

string

Name of the container to filter logs by.

--pod

-p

string

Name of the pod to filter logs by.

--node-id

-n

string

ID of the workflow node to filter logs by.

--follow

-f

bool

Follow log stream until the Run finishes.

Update a cluster

Requires admin permissions.

Argument/Flag
Type
Description

cluster-name

string

Name of the cluster to update. Required (positional).

--name

string

New name for the cluster.

--description

string

New description for the cluster.

--status

string

New status for the cluster (active or inactive).

Import from Workflow Archive

Admins can import archived workflows from an Argo Workflow Archive into Pipekit:

Flag
Shorthand
Type
Description

--cluster-name

-c

string

Name of the cluster to assign workflows to. Required.

--argoServerURI

string

Argo Server URI (defaults to localhost:2746).

--argoAuthToken

string

Argo Server authentication token.

--batchSize

integer

Number of workflows to fetch from the Workflow Archive per API call (defaults to 10).

--argoServerSubPath

string

Sub-path used when connecting to Argo Server.

--insecure

-k

bool

Skip TLS verification (defaults to false).

--useSSL

bool

Use SSL when connecting to Argo Server (defaults to true).

What's next

  • Cron Workflows: CronWorkflow lifecycle commands.

  • Using with Hera: token generation for Hera-authored workflows.

  • Advanced: Docker container usage, non-interactive login, token storage, log-level flags.

Last updated