Skip to main content

Quickstart

Get up and running with ProAI in under 5 minutes.

Prerequisites​

  • Node.js 18+ installed
  • A ProAI account (sign up free)
  • Terminal / command line access

Step 1: Install the CLI​

ash npm install -g @proai/cli

Verify the installation:

`ash proai --version

proai/2.0.0 win32-x64 node-v20.10.0

`

Step 2: Authenticate​

ash proai login

This opens your browser for SSO authentication. After completing login, your CLI is authenticated.

Step 3: Initialize a Project​

ash proai init my-first-project cd my-first-project

This creates the project structure:

my-first-project/ proai.yml # Project configuration pipelines/ # Pipeline definitions transforms/ # Custom transformations tests/ # Pipeline tests

Step 4: Create Your First Pipeline​

ash proai pipeline create hello-world

Open pipelines/hello-world.yml in your editor:

pipeline: hello-world
description: My first ProAI pipeline

sources:
  - name: csv_input
    type: file
    config:
      path: ./data/input.csv

transforms:
  - name: filter_rows
    type: sql
    query: |
      SELECT * FROM csv_input
      WHERE status = 'active'

destinations:
  - name: output
    type: file
    config:
      path: ./data/output.csv
`

## Step 5: Run Locally

`ash
proai dev
`

Your pipeline executes in development mode with hot-reloading enabled.

## Next Steps

- [Installation Guide](/docs/getting-started/installation) — Full installation options
- [First Project](/docs/getting-started/first-project) — Detailed project setup
- [Your First ETL](/docs/getting-started/your-first-etl) — Build a real ETL pipeline