Beginner Tutorial

First-Time Setup

Connect to Existing Instance

Language Clients

Defer Processing via Staging Branch

Skip Failed Datums

Time-Windowed Data

Build Pipelines & DAGs

Create a Pipeline

Delete a Pipeline

Jsonnet Pipeline Specifications

Update a Pipeline

Create a Project

Set a Project as Current

Add a Project Resource

Grant Project Access

Delete a Project

Process Specific Commits

Set Branch Triggers

Set Output Branch

List Global Commits & Jobs

List Global ID Sub Commits

Track Downstream

Delete Branch Head

Squash Non-Head Commits

Delete File From History

Standard ML Pipeline

AutoML Pipeline

Multi-Pipeline DAG

Data Parallelism Pipeline

Task Parallelism Pipeline

Docker Image + User Code

Egress To An SQL Database

Export via Egress

Export via PachCTL

Mount a Repo Locally

S3 Gateway Operations

Create S3 Bucket

Delete an S3 Object

Delete Empty S3 Bucket

Get an S3 Object

List S3 Buckets

List S3 Objects

Write an S3 Object

Google BigQuery

Docker Installation Guide

Local Installation Guide

Troubleshooting

Weights and Biases

Pachctl auth activate

Pachctl auth check

Pachctl auth check project

Pachctl auth check repo

Pachctl auth deactivate

Pachctl auth get config

Pachctl auth get groups

Pachctl auth get robot token

Pachctl auth get

Pachctl auth get cluster

Pachctl auth get enterprise

Pachctl auth get project

Pachctl auth get repo

Pachctl auth login

Pachctl auth logout

Pachctl auth revoke

Pachctl auth roles for permission

Pachctl auth rotate root token

Pachctl auth set config

Pachctl auth set

Pachctl auth set cluster

Pachctl auth set enterprise

Pachctl auth set project

Pachctl auth set repo

Pachctl auth use auth token

Pachctl auth whoami

Pachctl buildinfo

Pachctl completion

Pachctl completion bash

Pachctl completion zsh

Pachctl config delete

Pachctl config delete context

Pachctl config get

Pachctl config get active context

Pachctl config get active enterprise context

Pachctl config get context

Pachctl config get metrics

Pachctl config import kube

Pachctl config list

Pachctl config list context

Pachctl config set

Pachctl config set active context

Pachctl config set active enterprise context

Pachctl config set context

Pachctl config set metrics

Pachctl config update

Pachctl config update context

Pachctl connect

Pachctl copy file

Pachctl create branch

Pachctl create pipeline

Pachctl create project

Pachctl create repo

Pachctl create secret

Pachctl debug analyze

Pachctl debug binary

Pachctl debug dump

Pachctl debug log level

Pachctl debug profile

Pachctl delete all

Pachctl delete branch

Pachctl delete commit

Pachctl delete file

Pachctl delete job

Pachctl delete pipeline

Pachctl delete project

Pachctl delete repo

Pachctl delete secret

Pachctl delete transaction

Pachctl diff file

Pachctl draw pipeline

Pachctl edit pipeline

Pachctl enterprise

Pachctl enterprise deactivate

Pachctl enterprise get state

Pachctl enterprise heartbeat

Pachctl enterprise pause status

Pachctl enterprise pause

Pachctl enterprise register

Pachctl enterprise sync contexts

Pachctl enterprise unpause

Pachctl find commit

Pachctl finish commit

Pachctl finish transaction

Pachctl get file

Pachctl glob file

Pachctl idp create client

Pachctl idp create connector

Pachctl idp delete client

Pachctl idp delete connector

Pachctl idp get client

Pachctl idp get config

Pachctl idp get connector

Pachctl idp list client

Pachctl idp list connector

Pachctl idp set config

Pachctl idp update client

Pachctl idp update connector

Pachctl inspect

Pachctl inspect branch

Pachctl inspect cluster

Pachctl inspect commit

Pachctl inspect datum

Pachctl inspect file

Pachctl inspect job

Pachctl inspect pipeline

Pachctl inspect project

Pachctl inspect repo

Pachctl inspect secret

Pachctl inspect transaction

Pachctl kube events

Pachctl license

Pachctl license activate

Pachctl license add cluster

Pachctl license delete all

Pachctl license delete cluster

Pachctl license get state

Pachctl license list clusters

Pachctl license update cluster

Pachctl list branch

Pachctl list commit

Pachctl list datum

Pachctl list file

Pachctl list job

Pachctl list pipeline

Pachctl list project

Pachctl list repo

Pachctl list secret

Pachctl list transaction

👉 Pachctl port forward

Pachctl put file

Pachctl restart

Pachctl restart datum

Pachctl resume transaction

Pachctl run cron

Pachctl run pfs load test

Pachctl run pps load test

Pachctl squash commit

Pachctl start commit

Pachctl start pipeline

Pachctl start transaction

Pachctl stop job

Pachctl stop pipeline

Pachctl stop transaction

Pachctl subscribe

Pachctl subscribe commit

Pachctl unmount

Pachctl update pipeline

Pachctl update project

Pachctl update repo

Pachctl version

Pachctl wait commit

Pachctl wait job

Debug Pipelines

Troubleshooting Deployments

View Audit Logs

View Kubernetes Logs

Coding Conventions

Contributor Setup

Developing on Windows with VSCode

Documentation Style Guide

GitHub

Pachctl port forward

pachctl port-forward #

Forward a port on the local machine to pachd. This command blocks.

Synopsis #

Forward a port on the local machine to pachd. This command blocks.

pachctl port-forward [flags]

Options #

      --console-port uint16            The local port to bind the console service to. (default 4000)
      --dex-port uint16                The local port to bind the identity service to. (default 30658)
  -h, --help                           help for port-forward
      --namespace string               Kubernetes namespace Pachyderm is deployed in.
      --oidc-port uint16               The local port to bind pachd's OIDC callback to. (default 30657)
  -p, --port uint16                    The local port to bind pachd to. (default 30650)
      --remote-console-port uint16     The remote port to bind the console  service to. (default 4000)
      --remote-dex-port uint16         The local port to bind the identity service to. (default 1658)
      --remote-oidc-port uint16        The remote port that OIDC callback is bound to in the cluster. (default 1657)
      --remote-port uint16             The remote port that pachd is bound to in the cluster. (default 1650)
      --remote-s3gateway-port uint16   The remote port that the s3 gateway is bound to. (default 1600)
  -s, --s3gateway-port uint16          The local port to bind the s3gateway to. (default 30600)

Options inherited from parent commands #

      --no-color   Turn off colors.
  -v, --verbose    Output verbose logs