Prolific CLI

The Prolific CLI is a command-line tool for interacting with the Prolific API. It provides a convenient way to manage studies, submissions, and other resources directly from your terminal.

Overview

Use the Prolific CLI to:

• Manage studies (create, list, view, update, publish) and submissions
• Manage credentials, filter sets, participant groups, and hooks
• Send and retrieve messages
• Manage workspaces and projects
• Automate common workflows via scripts

The CLI supports both interactive and non-interactive modes, making it suitable for both exploratory use and integration into automated workflows.

Getting started

The Prolific CLI is available on GitHub. Follow the instructions below to install and run it.

Installation

$
go install github.com/prolific-oss/cli/cmd/prolific@latest

Requirements

• Go 1.26+ (only needed if building from source)

For more details, see the installation guide.

Configuration

Authentication

Set the PROLIFIC_TOKEN environment variable with your API token:

$
export PROLIFIC_TOKEN="<your token>"

You can create a Researcher token in your account settings.

Optional settings

You can optionally override the API URL if Prolific have granted you access to a different environment:

$
export PROLIFIC_URL="https://api.prolific.com"

You can also define defaults in a configuration file at $HOME/.config/prolific-oss/prolific.yaml:

1
workspace: <your workspace id>

For more details, see the configuration guide .

Available commands

$
prolific [command]

Global flags

Use prolific [command] --help for more information about a specific command.

Contributing

We welcome contributions. See the Contributing Guide on GitHub for details on how to get started.