Get Started with PipeForge

From zero to production pipeline in under 5 minutes.

Prerequisites

✓ Git installed and configured
✓ A GitHub, GitLab, or Bitbucket account
✓ Node.js 18+ (for npm install method)
✓ Free PipeForge account — sign up here

Install the CLI

PipeForge CLI works on macOS, Linux, and Windows. Install in seconds.

terminal

# macOS / Linux
curl -fsSL https://get.pipeforge.dev | sh

# or with npm
npm install -g @pipeforge/cli

# or with Homebrew
brew install pipeforge/tap/pipeforge

# Verify installation
pipeforge --version
# pipeforge v3.2.0

Authenticate

Connect your PipeForge account and link your Git provider.

terminal

# Login to PipeForge
pipeforge auth login

# Connect your Git provider
pipeforge auth connect github
# ✓ Connected to GitHub as @your-username

# Verify connection
pipeforge auth status
# Logged in as: you@email.com
# Organization: your-org
# Git Provider: GitHub (connected)

Initialize your project

Create a pipeline config with sensible defaults for your stack.

terminal

# In your project directory
pipeforge init

# ✓ Detected: Node.js (package.json)
# ✓ Detected: TypeScript (tsconfig.json)
# ✓ Detected: Docker (Dockerfile)
# ✓ Created: pipeforge.yaml
# ✓ Created: .pipeforge/settings.json

# Or start from a template
pipeforge init --template nextjs
pipeforge init --template rust-service
pipeforge init --template python-api

Configure your pipeline

Edit the generated YAML or use the visual editor.

terminal

# pipeforge.yaml (generated)
pipeline:
  name: my-app
  trigger:
    branches: [main]
    pull_requests: true

stages:
  - name: build-and-test
    steps:
      - run: npm ci
      - run: npm test
      - run: npm run build
    cache:
      - node_modules/
    artifacts:
      - path: dist/**

  - name: deploy
    needs: [build-and-test]
    target: cloudflare-pages
    project: my-app

Run your first build

Trigger a build locally or push to run in the cloud.

terminal

# Run locally (great for debugging)
pipeforge run --local

# Or push to trigger cloud build
git add pipeforge.yaml
git commit -m "Add PipeForge pipeline"
git push origin main

# Watch the build
pipeforge watch
# [build-and-test] npm ci... ✓ (cached, 2.1s)
# [build-and-test] npm test... ✓ (142 passed)
# [build-and-test] npm run build... ✓ (12.4s)
# [deploy] Deploying to Cloudflare Pages... ✓
# Pipeline completed in 18.6s

What's next?

Visual Pipeline Editor

Design pipelines with drag-and-drop

Configure Caching

Speed up builds by 80%

Container Registry

Push and scan Docker images

Try the Playground

Experiment without setup