Getting Started

Installation

Install the latest release with go install:

go install github.com/pipectl/pipectl/cmd/pipectl@latest

Or build from source:

git clone https://github.com/pipectl/pipectl.git
cd pipectl
go build ./cmd/pipectl

Verify the installation:

pipectl --help

Your first pipeline

Create a pipeline file:

# greet.yaml
id: greet
input:
  format: json
steps:
  - normalize:
      fields:
        name: capitalize
  - select:
      fields: [name, email]
output:
  format: json

Create some input:

echo '[{"name":"alice smith","email":"ALICE@EXAMPLE.COM"},{"name":"bob jones","email":"BOB@EXAMPLE.COM"}]' > people.json

Run it:

pipectl run greet.yaml < people.json

Or use --input instead of stdin redirection:

pipectl run greet.yaml --input people.json

Output:

[{"email":"ALICE@EXAMPLE.COM","name":"Alice Smith"},{"email":"BOB@EXAMPLE.COM","name":"Bob Jones"}]

Validate without running

Use --dry-run to check a pipeline is valid and see the planned steps without executing anything:

pipectl run greet.yaml --dry-run

Pipeline: greet
Steps:
  1. normalize
  2. select

Write output to a file

By default pipectl writes to stdout. Use -o to write to a file instead:

pipectl run greet.yaml -o output.json < people.json

Enable verbose logging

Use --verbose to see per-step detail — record counts, field operations, sort results — written to stderr:

pipectl run greet.yaml --verbose < people.json

Next steps

• Read Core Concepts to understand how pipelines, steps, and payloads fit together
• Browse the Step Reference to see all available steps
• Explore Example Pipelines for real-world patterns