Quickstart

Previous Next

Get your first experiment running in minutes using the Pairit CLI.

Install the CLI

npm install -g pairit
# or
bun install -g pairit

Authenticate

pairit login

This opens a browser window for Google OAuth when available. On a remote or headless server, the CLI prints a login URL instead; open it on your local machine, sign in, and paste the one-time authorization code back into the CLI.

Create Your First Experiment

1. Create my-experiment.yaml:

schema_version: 0.1.0
initialPageId: intro

pages:
  - id: intro
    components:
      - type: text
        props:
          text: "Welcome to the study!"
      - type: buttons
        props:
          buttons:
            - id: start
              text: "Start"
              action: { type: go_to, target: survey }

  - id: survey
    components:
      - type: survey
        props:
          items:
            - id: age
              text: "What is your age?"
              answer: numeric
      - type: buttons
        props:
          buttons:
            - id: submit
              text: "Submit"
              action: { type: go_to, target: thanks }

  - id: thanks
    end: true
    components:
      - type: text
        props:
          text: "Thank you for participating!"

2. Validate your config:

pairit config lint my-experiment.yaml

3. Upload to the server:

pairit config upload my-experiment.yaml --config-id my-experiment

If your experiment uses AI agents, include the provider key for that experiment when uploading:

pairit config upload my-experiment.yaml \
  --config-id my-experiment \
  --openai-api-key sk-...

or:

pairit config upload my-experiment.yaml \
  --config-id my-experiment \
  --anthropic-api-key sk-ant-...

These keys are stored encrypted per experiment. Pairit does not use a shared platform provider key for experiment agent runs; if the required provider key is missing, the agent run fails.

Re-uploading the same configId without a new key keeps the previously stored key for that experiment.

4. Share the experiment link with participants: https://lab.pairium.ai/my-experiment

Export Data

pairit data export my-experiment --format csv --output results.csv

Next Steps

Overview Concepts