Full CLI Reference
Generated from live help
This page is generated by npm run docs:v2:generate from node bin/psycloud ... --help.
Use it as the exhaustive option reference; the curated CLI guide is the faster workflow overview.
Commands
| Command | Section |
|---|---|
psycloud | Root |
psycloud init | Initialize |
psycloud list | List Templates |
psycloud serve | Serve |
psycloud run | Run |
psycloud run local | Run Locally |
psycloud run create | Create Cloud Run |
psycloud run activate | Activate Cloud Run |
psycloud build | Build HTML |
psycloud publish-bundle | Publish Study Bundle |
psycloud export-run | Export Local Run |
psycloud analyze | Analyze |
psycloud validate | Validate Project Bundle |
psycloud inspect | Inspect Project Bundle |
psycloud compile | Compile Project Bundle |
psycloud doctor | Doctor Study Bundle |
psycloud import | Import |
psycloud export-code | Export SDK Code |
psycloud workbench | Workbench |
psycloud workbench preflight | Workbench Preflight |
psycloud workbench check | Workbench Check |
psycloud workbench plot | Workbench Plot |
psycloud workbench plot flow | Workbench Plot Flow |
psycloud workbench plot trials | Workbench Plot Trials |
psycloud workbench plot timeline | Workbench Plot Timeline |
psycloud workbench preview | Workbench Preview |
psycloud workbench preview screen | Workbench Preview Screen |
psycloud workbench preview sequence | Workbench Preview Sequence |
psycloud workbench preview gallery | Workbench Preview Gallery |
psycloud workbench simulate | Workbench Simulate |
psycloud auth | Authenticate |
psycloud auth login | Auth Login |
psycloud auth status | Auth Status |
psycloud auth logout | Auth Logout |
psycloud deploy | Deploy |
psycloud cloud | Cloud |
psycloud cloud me | Cloud Me |
psycloud cloud projects | Cloud Projects |
psycloud cloud projects create | Cloud Projects Create |
psycloud cloud projects list | Cloud Projects List |
psycloud cloud studies | Cloud Studies |
psycloud cloud studies create | Cloud Studies Create |
psycloud cloud studies list | Cloud Studies List |
psycloud cloud connectors | Cloud Connectors |
psycloud cloud connectors mturk-set | Cloud MTurk Connector |
psycloud cloud exports | Cloud Exports |
psycloud cloud exports run-csv | Cloud Export Run CSV |
psycloud recruit | Recruit |
psycloud recruit prolific | Recruit Prolific |
psycloud recruit prolific create | Prolific Create |
psycloud recruit prolific publish | Prolific Publish |
psycloud recruit prolific status | Prolific Status |
psycloud recruit prolific extend | Prolific Extend |
psycloud recruit prolific submissions | Prolific Submissions |
psycloud recruit prolific submissions list | Prolific Submissions List |
psycloud recruit prolific submissions approve | Prolific Approve |
psycloud recruit prolific submissions reject | Prolific Reject |
psycloud recruit prolific submissions complete | Prolific Complete |
psycloud recruit prolific submissions bulk-approve | Prolific Bulk Approve |
psycloud recruit mturk | Recruit MTurk |
psycloud recruit mturk create | MTurk Create |
psycloud recruit mturk publish | MTurk Publish |
psycloud recruit mturk status | MTurk Status |
psycloud recruit mturk approve | MTurk Approve |
psycloud recruit mturk balance | MTurk Balance |
psycloud recruit mturk hit | MTurk HIT |
psycloud recruit mturk extend | MTurk Extend |
psycloud recruit mturk expire | MTurk Expire |
psycloud recruit mturk dispose | MTurk Dispose |
psycloud mturk | Legacy MTurk |
psycloud mturk package | Legacy MTurk Package |
psycloud mturk validate | Legacy MTurk Validate |
psycloud mturk test | Legacy MTurk Test |
psycloud mturk results | Legacy MTurk Results |
psycloud init:pavlovia | Pavlovia Init |
psycloud deploy-pavlovia | Pavlovia Deploy |
psycloud
Usage: psycloud [options] [command]
CLI for running PsyCloud psychological experiments
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
run [options] [script] Run a StudyBundle locally (bundle.json|bundle.zip), or create cloud runs
serve [options] <script> Serve experiment with live reload for development
build [options] <script> Build standalone HTML file from experiment
publish-bundle [options] <irJson> Publish an IR study into a provenance-locked Study Bundle (bundle.json)
export-run [options] <runId> Export a local run as a Trial Table Snapshot v0.1 (ZIP)
init [options] [name] Create a new PsyCloud experiment from template
list List available templates and examples
analyze [options] <script> Analyze experiment structure and generate visualizations
mturk MTurk integration commands
init:pavlovia [options] [name] Create a new Pavlovia-ready experiment from template
deploy-pavlovia [options] <experiment> Deploy an experiment to Pavlovia/GitLab
compile [options] <path> Compile a Project Bundle into a Study Bundle
doctor [options] <path> Sanity-check a compiled Study Bundle (bundle.json or bundle.zip)
validate [options] <path> Validate a Project Bundle without compiling
inspect [options] <path> Display detailed information about a Project Bundle
import [options] <source> Import an experiment from jsPsych, PsychoJS, PsychoPy (.psyexp), or Project Bundle
export-code [options] <source> Generate SDK source code (Python, R, TypeScript) from an imported study
workbench Workbench utilities
recruit Recruitment provider commands
auth Authenticate to PsyCloud (cloud control plane)
deploy [options] <path> Deploy a Project Bundle to PsyCloud Cloud (creates a Release)
cloud Cloud control-plane utilities (no Studio required)
help [command] display help for commandpsycloud init
Usage: psycloud init [options] [name]
Create a new PsyCloud experiment from template
Options:
-t, --template <template> Template to use (simple|canvas|html|full) (default:
"simple")
-l, --language <lang> Language (coffee|js|typescript) (default: "coffee")
-d, --dir <dir> Output directory (default: ".")
-h, --help display help for commandpsycloud list
Usage: psycloud list [options]
List available templates and examples
Options:
-h, --help display help for commandpsycloud serve
Usage: psycloud serve [options] <script>
Serve experiment with live reload for development
Options:
-p, --port <port> Server port (default: "3333")
-w, --watch Watch for file changes (default: true)
-o, --open Open browser automatically (default: true)
-b, --build <type> PsyCloud build type (minimal|standard|full|auto) (default:
"auto")
--host <host> Server host (default: "localhost")
-h, --help display help for commandpsycloud run
Usage: psycloud run [options] [command] [script]
Run a StudyBundle locally (bundle.json|bundle.zip), or create cloud runs
Options:
-p, --port <port> Server port (default: "3333")
-o, --open Open browser (bundle runner: off by default)
--no-open Do not open browser
-b, --build <type> PsyCloud build type (minimal|standard|full|auto)
(default: "auto")
-d, --debug Enable debug mode with console (default: false)
--data <file> Save response data to file
--no-cache Disable caching
--host <host> Server host (bundle runner) (default: "localhost")
--base-url <url> Override URL to print/open (advanced)
--verbose Verbose bundle runner output (default: false)
-h, --help display help for command
Commands:
local [options] <script> Run a PsyCloud experiment script locally
activate [options] Activate a Run so participants can join
create [options] Create a Run from a Release (participant entrypoint)psycloud run local
Usage: psycloud run local [options] <script>
Run a PsyCloud experiment script locally
Options:
-p, --port <port> Server port (default: "3333")
-o, --open Open browser (bundle runner: off by default)
--no-open Do not open browser
-b, --build <type> PsyCloud build type (minimal|standard|full|auto) (default:
"auto")
-d, --debug Enable debug mode with console (default: false)
--data <file> Save response data to file
--no-cache Disable caching
-h, --help display help for commandpsycloud run create
Usage: psycloud run create [options]
Create a Run from a Release (participant entrypoint)
Options:
--release <id> Release ID (currently: bundleHash)
--name <name> Run name
--mode <mode> Run mode (pilot|production) (default: "pilot")
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--run-base-url <url> Participant entry base URL (default:
https://run.psycloud.io)
--app <url> PsyCloud app base URL (for deep links)
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud run activate
Usage: psycloud run activate [options]
Activate a Run so participants can join
Options:
--run <runId> Run ID
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud build
Usage: psycloud build [options] <script>
Build standalone HTML file from experiment
Options:
-o, --output <file> Output HTML file (default: "experiment.html")
-b, --build <type> PsyCloud build type (minimal|standard|full|auto)
(default: "auto")
-m, --minify Minify output (default: false)
-i, --inline Inline all assets in HTML (default: true)
--separate Keep JS/CSS as separate files (default: false)
--source-maps Include source maps (default: false)
-h, --help display help for commandpsycloud publish-bundle
Usage: psycloud publish-bundle [options] <irJson>
Publish an IR study into a provenance-locked Study Bundle (bundle.json)
Options:
-o, --output <file> Output bundle.json path (default:
"bundle.json")
--mode <mode> Publish mode (verified|extended) (default:
"verified")
--allow-errors Allow publishing even if validator errors exist
(extended only) (default: false)
--runtime-version <version> Runtime version to stamp into bundle (default:
"0.0.1")
--telemetry-version <version> Telemetry schema version to stamp into bundle
(default: current)
-h, --help display help for commandpsycloud export-run
Usage: psycloud export-run [options] <runId>
Export a local run as a Trial Table Snapshot v0.1 (ZIP)
Options:
-o, --output <file> Output zip file path
-h, --help display help for commandpsycloud analyze
Usage: psycloud analyze [options] <script>
Analyze experiment structure and generate visualizations
Options:
-o, --output <dir> Output directory (default: "./analysis")
-h, --help display help for commandpsycloud validate
Usage: psycloud validate [options] <path>
Validate a Project Bundle without compiling
Options:
-s, --strict Enable strict mode (fail on warnings) (default: false)
-v, --verbose Verbose output (default: false)
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud inspect
Usage: psycloud inspect [options] <path>
Display detailed information about a Project Bundle
Options:
-s, --section <section> Section to inspect
(all|manifest|design|screen|bindings|counterbalance|assets)
(default: "all")
-v, --verbose Verbose output with full details (default: false)
--json Output only JSON (for scripting) (default: false)
-d, --depth <n> Max depth for nested output (default: "3")
-h, --help display help for commandpsycloud compile
Usage: psycloud compile [options] <path>
Compile a Project Bundle into a Study Bundle
Options:
-o, --out <path> Output path for the Study Bundle
-s, --strict Enable strict mode (fail on warnings) (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
-f, --format <format> Output format (json|zip) (default: "json")
-v, --verbose Verbose output (default: false)
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud doctor
Usage: psycloud doctor [options] <path>
Sanity-check a compiled Study Bundle (bundle.json or bundle.zip)
Options:
-s, --strict Enable strict mode (fail on warnings) (default: false)
--check-assets Verify asset file hashes on disk (default: false)
--max-assets <n> Limit number of assets to hash-check (default: all)
--no-check-bundle-hash Skip canonical bundleHash verification
-v, --verbose Verbose output (default: false)
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud import
Usage: psycloud import [options] <source>
Import an experiment from jsPsych, PsychoJS, PsychoPy (.psyexp), or Project
Bundle
Options:
-o, --out <path> Output path for the imported project
-f, --format <format> Source format
(jspsych|psychojs|psychopy|project-bundle|auto)
(default: "auto")
--dry-run Validate only, do not create project (default: false)
--skip-simulation Skip simulation stage (default: true)
-v, --verbose Verbose output (default: false)
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud export-code
Usage: psycloud export-code [options] <source>
Generate SDK source code (Python, R, TypeScript) from an imported study
Options:
-l, --lang <language> Target language (python|r|typescript|all) (default:
"python")
-o, --out <path> Output file path (default: stdout for single language)
--no-comments Exclude comments from generated code
--no-fluent Use low-level API instead of fluent style
-v, --verbose Verbose output (default: false)
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench
Usage: psycloud workbench [options] [command]
Workbench utilities
Options:
-h, --help display help for command
Commands:
preflight [options] <path> Generate a workbench preflight report for a
Project Bundle
check [options] <path> Generate a workbench check report for a Project
Bundle
plot Render workbench visualizations
preview Render workbench previews
simulate [options] <path> Simulate design-program execution
(TrialInstance/TrialResult loop)
help [command] display help for commandpsycloud workbench preflight
Usage: psycloud workbench preflight [options] <path>
Generate a workbench preflight report for a Project Bundle
Options:
-o, --out <path> Output path for JSON report (default:
"workbench-report.json")
--html [path] Output HTML report (optional path)
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench check
Usage: psycloud workbench check [options] <path>
Generate a workbench check report for a Project Bundle
Options:
-o, --out <path> Output path for JSON report (default:
"workbench-check.json")
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench plot
Usage: psycloud workbench plot [options] [command]
Render workbench visualizations
Options:
-h, --help display help for command
Commands:
flow [options] <path> Render the study flow tree (TaskFlow HTML or ASCII)
trials [options] <path> Render trial balance summaries (ASCII or HTML)
timeline [options] <path> Render a trial template timeline (ASCII)
help [command] display help for commandpsycloud workbench plot flow
Usage: psycloud workbench plot flow [options] <path>
Render the study flow tree (TaskFlow HTML or ASCII)
Options:
-o, --out <path> Output path for plot (default: "workbench-flow.html")
--report <path> Optional output path for JSON report
-f, --format <format> Output format (html|ascii) (default: "html")
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench plot trials
Usage: psycloud workbench plot trials [options] <path>
Render trial balance summaries (ASCII or HTML)
Options:
-o, --out <path> Output path for plot
--report <path> Optional output path for JSON report
-f, --format <format> Output format (ascii|html) (default: "ascii")
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench plot timeline
Usage: psycloud workbench plot timeline [options] <path>
Render a trial template timeline (ASCII)
Options:
-o, --out <path> Output path for timeline (default:
"workbench-timeline.txt")
--report <path> Optional output path for JSON report
--scope-id <id> Scope ID whose trial template should be rendered
--template-id <id> Explicit trial template id to render
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench preview
Usage: psycloud workbench preview [options] [command]
Render workbench previews
Options:
-h, --help display help for command
Commands:
screen [options] <path> Preview a single screen with a sample trial row
sequence [options] <path> Preview a sequence of trials for a phase/scope
gallery [options] <path> Preview all pipeline scopes with sample trials
help [command] display help for commandpsycloud workbench preview screen
Usage: psycloud workbench preview screen [options] <path>
Preview a single screen with a sample trial row
Options:
-o, --out <path> Output path for preview HTML (default:
"workbench-preview.html")
--report <path> Optional output path for JSON report
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--scope-id <id> Scope ID to preview
--trial-index <index> Trial row index
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench preview sequence
Usage: psycloud workbench preview sequence [options] <path>
Preview a sequence of trials for a phase/scope
Options:
-o, --out <path> Output path for preview HTML (default:
"workbench-preview.html")
--report <path> Optional output path for JSON report
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--scope-id <id> Scope ID to preview
--limit <n> Max rows to preview
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench preview gallery
Usage: psycloud workbench preview gallery [options] <path>
Preview all pipeline scopes with sample trials
Options:
-o, --out <path> Output path for preview HTML (default:
"workbench-preview.html")
--report <path> Optional output path for JSON report
-s, --strict Enable strict compile mode (default: false)
-m, --mode <mode> Compilation mode (preview|publish) (default: "preview")
--preview-seed <seed> Seed for design preview materialization
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud workbench simulate
Usage: psycloud workbench simulate [options] <path>
Simulate design-program execution (TrialInstance/TrialResult loop)
Options:
-o, --out <path> Output path for simulation JSON (default:
workbench-simulate.json in human mode)
--behavior <behavior> Behavior
(random|alwaysCorrect|alwaysIncorrect|alternating|timeout)
(default: "random")
--participants <n> Number of participants (default: 10)
--max-trials <n> Max trials per participant (cap) (default: 1000)
--seed <n> Base seed for deterministic simulation (default: 1337)
--rt-ms <n> Response time in ms (when applicable)
--assignment <json> Assignment JSON (e.g. '{"condition":"A"}')
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud auth
Usage: psycloud auth [options] [command]
Authenticate to PsyCloud (cloud control plane)
Options:
-h, --help display help for command
Commands:
status [options] Show current auth status
logout [options] Clear locally stored credentials
login [options] Login via browser OAuth (no passwords in terminal)
help [command] display help for commandpsycloud auth login
Usage: psycloud auth login [options]
Login via browser OAuth (no passwords in terminal)
Options:
--api <url> PsyCloud API base URL
--provider <name> OAuth provider (e.g., github, google)
--code <code> OAuth session code to exchange for tokens
--token <token> Set access token directly (advanced)
--credentials <path> Credentials file path
--open Open the login URL in a browser (default: true)
-h, --help display help for commandpsycloud auth status
Usage: psycloud auth status [options]
Show current auth status
Options:
--credentials <path> Credentials file path
--api <url> PsyCloud API base URL
-h, --help display help for commandpsycloud auth logout
Usage: psycloud auth logout [options]
Clear locally stored credentials
Options:
--credentials <path> Credentials file path
-h, --help display help for commandpsycloud deploy
Usage: psycloud deploy [options] <path>
Deploy a Project Bundle to PsyCloud Cloud (creates a Release)
Options:
--cloud Deploy to PsyCloud Cloud (default: false)
--study <studyId> Study ID to attach this Release to
--mode <mode> Release verification level (verified|extended) (default:
"verified")
--allow-errors Unsupported by ProjectBundle ingest; use --mode extended
to allow warnings (default: false)
--tag <tag> Unsupported by ProjectBundle ingest yet
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud cloud
Usage: psycloud cloud [options] [command]
Cloud control-plane utilities (no Studio required)
Options:
-h, --help display help for command
Commands:
me [options] Show current user + workspace memberships
projects Manage projects
studies Manage studies
connectors Manage workspace connectors
exports Download exports
help [command] display help for commandpsycloud cloud me
Usage: psycloud cloud me [options]
Show current user + workspace memberships
Options:
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud cloud projects
Usage: psycloud cloud projects [options] [command]
Manage projects
Options:
-h, --help display help for command
Commands:
create [options] Create a Project in a Workspace
list [options] List Projects you can access
help [command] display help for commandpsycloud cloud projects create
Usage: psycloud cloud projects create [options]
Create a Project in a Workspace
Options:
--workspace <workspaceId> Workspace ID
--name <name> Project name
--description <text> Project description
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud cloud projects list
Usage: psycloud cloud projects list [options]
List Projects you can access
Options:
--workspace <workspaceId> Filter by workspace ID
--search <text> Search by name/description
--limit <n> Limit
--offset <n> Offset
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud cloud studies
Usage: psycloud cloud studies [options] [command]
Manage studies
Options:
-h, --help display help for command
Commands:
create [options] Create a Study in a Project
list [options] List Studies you can access
help [command] display help for commandpsycloud cloud studies create
Usage: psycloud cloud studies create [options]
Create a Study in a Project
Options:
--project <projectId> Project ID
--title <title> Study title
--description <text> Study description
--tag <tag...> Tags (repeatable)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud cloud studies list
Usage: psycloud cloud studies list [options]
List Studies you can access
Options:
--project <projectId> Filter by project ID
--search <text> Search by title/description
--limit <n> Limit
--offset <n> Offset
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud cloud connectors
Usage: psycloud cloud connectors [options] [command]
Manage workspace connectors
Options:
-h, --help display help for command
Commands:
mturk-set [options] Set/validate MTurk credentials for a workspace (stored
server-side)
help [command] display help for commandpsycloud cloud connectors mturk-set
Usage: psycloud cloud connectors mturk-set [options]
Set/validate MTurk credentials for a workspace (stored server-side)
Options:
--workspace <workspaceId> Workspace ID
--access-key-id <id> AWS access key id (defaults to
AWS_ACCESS_KEY_ID/env or prompt)
--secret-access-key <key> AWS secret access key (defaults to
AWS_SECRET_ACCESS_KEY/env or prompt)
--session-token <token> AWS session token (optional)
--allow-insecure-cli-secrets Allow passing AWS secrets on the command line
(NOT recommended) (default: false)
--env <environment> sandbox|production (default: "sandbox")
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default:
false)
-h, --help display help for commandpsycloud cloud exports
Usage: psycloud cloud exports [options] [command]
Download exports
Options:
-h, --help display help for command
Commands:
run-csv [options] Download the latest derived CSV for a run
help [command] display help for commandpsycloud cloud exports run-csv
Usage: psycloud cloud exports run-csv [options]
Download the latest derived CSV for a run
Options:
--run <runId> Run ID
--out <path> Write to a file (default: stdout)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
-h, --help display help for commandpsycloud recruit
Usage: psycloud recruit [options] [command]
Recruitment provider commands
Options:
-h, --help display help for command
Commands:
prolific Prolific recruitment
mturk MTurk recruitment
help [command] display help for commandpsycloud recruit prolific
Usage: psycloud recruit prolific [options] [command]
Prolific recruitment
Options:
-h, --help display help for command
Commands:
create [options] Create a Prolific draft study and persist
RecruitmentBinding
extend [options] Increase total available places for a Prolific study (uses
stored RecruitmentBinding by default)
pause [options] Pause a Prolific study (uses stored RecruitmentBinding by
default)
start [options] Start/resume a Prolific study (uses stored
RecruitmentBinding by default)
stop [options] Stop a Prolific study (uses stored RecruitmentBinding by
default)
publish [options] Publish a Prolific draft study (uses stored
RecruitmentBinding by default)
status [options] Fetch Prolific remote study status (uses stored
RecruitmentBinding by default)
submissions List and transition Prolific submissions
help [command] display help for commandpsycloud recruit prolific create
Usage: psycloud recruit prolific create [options]
Create a Prolific draft study and persist RecruitmentBinding
Options:
--run <runId> Run to recruit for
--places <n> Number of participants
--minutes <n> Estimated completion time (minutes)
--reward <minorUnits> Reward in minor currency units (e.g., cents/pence)
--title <title> Study title in Prolific
--description <text> Study description in Prolific
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--run-base-url <url> Participant entry base URL (default:
https://run.psycloud.io)
--app <url> PsyCloud app base URL (for deep links)
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit prolific publish
Usage: psycloud recruit prolific publish [options]
Publish a Prolific draft study (uses stored RecruitmentBinding by default)
Options:
--run <runId> Run to publish recruitment for
--remote <remoteStudyId> Override Prolific remoteStudyId
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit prolific status
Usage: psycloud recruit prolific status [options]
Fetch Prolific remote study status (uses stored RecruitmentBinding by default)
Options:
--run <runId> Run to check recruitment for
--remote <remoteStudyId> Override Prolific remoteStudyId
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit prolific extend
Usage: psycloud recruit prolific extend [options]
Increase total available places for a Prolific study (uses stored
RecruitmentBinding by default)
Options:
--run <runId> Run to extend recruitment for
--remote <remoteStudyId> Override Prolific remoteStudyId
--total <n> Set total available places (absolute)
--add <n> Add places to current total (delta)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit prolific submissions
Usage: psycloud recruit prolific submissions [options] [command]
List and transition Prolific submissions
Options:
-h, --help display help for command
Commands:
list [options] List submissions for the run’s Prolific study
approve [options] Approve a submission
reject [options] Reject a submission (requires a >=100 char message and
a rejection category)
complete [options] Complete a submission using a Prolific completion code
(supports screen-out / dynamic payments)
bulk-approve [options] Bulk approve submissions by id
help [command] display help for commandpsycloud recruit prolific submissions list
Usage: psycloud recruit prolific submissions list [options]
List submissions for the run’s Prolific study
Options:
--run <runId> Run to list submissions for
--remote <remoteStudyId> Override Prolific remoteStudyId (study id)
--status <status> Filter by submission status (e.g., AWAITING_REVIEW)
--completed Only completed submissions (default: false)
--awaiting-review Only awaiting-review submissions (default: false)
--approved Only approved submissions (default: false)
--rejected Only rejected submissions (default: false)
--screened-out Only screened-out submissions (default: false)
--page <n> Page number
--page-size <n> Page size
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit prolific submissions approve
Usage: psycloud recruit prolific submissions approve [options]
Approve a submission
Options:
--run <runId> Run to act on
--submission <id> Submission id
--yes Confirm production write action (default: false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit prolific submissions reject
Usage: psycloud recruit prolific submissions reject [options]
Reject a submission (requires a >=100 char message and a rejection category)
Options:
--run <runId> Run to act on
--submission <id> Submission id
--category <category> Rejection category (Prolific API enum)
--message <text> Rejection message (>=100 chars)
--message-file <path> Read rejection message from file
--yes Confirm production write action (default: false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit prolific submissions complete
Usage: psycloud recruit prolific submissions complete [options]
Complete a submission using a Prolific completion code (supports screen-out /
dynamic payments)
Options:
--run <runId> Run to act on
--submission <id> Submission id
--code <completionCode> Completion code configured on the Prolific
study
--percent <n> percentage_of_reward for DYNAMIC_PAYMENT
(8-99)
--message-to-participant <text> Optional message to participant (dynamic
payment)
--yes Confirm production write action (default:
false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default:
false)
-h, --help display help for commandpsycloud recruit prolific submissions bulk-approve
Usage: psycloud recruit prolific submissions bulk-approve [options]
Bulk approve submissions by id
Options:
--run <runId> Run to act on
--submission <id> Submission id (repeatable) (default: [])
--yes Confirm production write action (default: false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk
Usage: psycloud recruit mturk [options] [command]
MTurk recruitment
Options:
-h, --help display help for command
Commands:
create [options] Create an MTurk HIT and persist RecruitmentBinding
balance [options] Fetch MTurk requester account balance (uses stored
RecruitmentBinding environment)
hit [options] Fetch MTurk HIT details (uses stored RecruitmentBinding by
default)
extend [options] Add additional assignments to an MTurk HIT
expire [options] Expire an MTurk HIT immediately (stops new accepts)
dispose [options] Dispose (delete) an MTurk HIT (may require HIT to be
Reviewable)
approve [options] Process submitted assignments and apply an approval policy
publish [options] Publish an MTurk HIT (uses stored RecruitmentBinding by
default)
status [options] Fetch MTurk remote study status (uses stored
RecruitmentBinding by default)
help [command] display help for commandpsycloud recruit mturk create
Usage: psycloud recruit mturk create [options]
Create an MTurk HIT and persist RecruitmentBinding
Options:
--run <runId> Run to recruit for
--assignments <n> Number of participants
--reward <amount> Reward in USD
--duration <seconds> Duration in seconds
--title <title> HIT title
--description <text> HIT description
--keywords <csv> HIT keywords (comma-separated)
--lifetime <seconds> HIT lifetime in seconds
--auto-approval-delay <seconds> Auto-approval delay in seconds
--sandbox Use sandbox environment
--yes Confirm production write action (default:
false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--app <url> PsyCloud app base URL (for deep links)
--json Output only JSON (for scripting) (default:
false)
-h, --help display help for commandpsycloud recruit mturk publish
Usage: psycloud recruit mturk publish [options]
Publish an MTurk HIT (uses stored RecruitmentBinding by default)
Options:
--run <runId> Run to publish recruitment for
--remote <remoteStudyId> Override MTurk HIT ID
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk status
Usage: psycloud recruit mturk status [options]
Fetch MTurk remote study status (uses stored RecruitmentBinding by default)
Options:
--run <runId> Run to check recruitment for
--remote <remoteStudyId> Override MTurk HIT ID
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk approve
Usage: psycloud recruit mturk approve [options]
Process submitted assignments and apply an approval policy
Options:
--run <runId> Run to process approvals for
--remote <remoteStudyId> Override MTurk HIT ID
--policy <mode> Approval policy (manual|hybrid) (default: "manual")
--yes Confirm production write action (required for hybrid
on production) (default: false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk balance
Usage: psycloud recruit mturk balance [options]
Fetch MTurk requester account balance (uses stored RecruitmentBinding
environment)
Options:
--run <runId> Run to check balance for
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk hit
Usage: psycloud recruit mturk hit [options]
Fetch MTurk HIT details (uses stored RecruitmentBinding by default)
Options:
--run <runId> Run to inspect
--remote <remoteStudyId> Override MTurk HIT ID
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk extend
Usage: psycloud recruit mturk extend [options]
Add additional assignments to an MTurk HIT
Options:
--run <runId> Run to extend recruitment for
--add <n> Additional assignments
--remote <remoteStudyId> Override MTurk HIT ID
--token <token> Idempotency token (UniqueRequestToken)
--yes Confirm production write action (default: false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk expire
Usage: psycloud recruit mturk expire [options]
Expire an MTurk HIT immediately (stops new accepts)
Options:
--run <runId> Run to expire recruitment for
--remote <remoteStudyId> Override MTurk HIT ID
--yes Confirm production write action (default: false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud recruit mturk dispose
Usage: psycloud recruit mturk dispose [options]
Dispose (delete) an MTurk HIT (may require HIT to be Reviewable)
Options:
--run <runId> Run to dispose recruitment for
--remote <remoteStudyId> Override MTurk HIT ID
--yes Confirm production write action (default: false)
--api <url> PsyCloud API base URL
--credentials <path> Credentials file path
--json Output only JSON (for scripting) (default: false)
-h, --help display help for commandpsycloud mturk
Usage: psycloud mturk [options] [command]
MTurk integration commands
Options:
-h, --help display help for command
Commands:
package [options] Generate a deployable MTurk HIT package
test [options] <html> Test an experiment with simulated MTurk
parameters
validate [options] <html> Validate an experiment HTML file for MTurk
deployment
results [options] <dataPath> Analyze collected MTurk study data
help [command] display help for commandpsycloud mturk package
Usage: psycloud mturk package [options]
Generate a deployable MTurk HIT package
Options:
-o, --output <dir> Output directory (default: "./mturk-deploy")
-t, --title <title> HIT title (default: "Psychology Experiment")
-d, --description <desc> HIT description (default: "Complete a brief
psychology experiment")
-k, --keywords <keywords> Keywords (comma-separated) (default:
"psychology,research,experiment")
-r, --reward <amount> Reward in USD (default: "1.00")
--duration <minutes> Assignment duration in minutes (default: "30")
-n, --assignments <count> Number of assignments (default: "9")
-u, --url <url> Experiment URL (if already hosted)
--sandbox Target sandbox environment (default) (default:
true)
--production Target production environment
--serverless Include AWS Lambda data collection template
--data-endpoint <url> Data collection endpoint URL
--time-estimate <minutes> Estimated completion time (shown to workers)
--contact <email> Contact email for support
--project <name> Project name (for filenames)
-h, --help display help for commandpsycloud mturk validate
Usage: psycloud mturk validate [options] <html>
Validate an experiment HTML file for MTurk deployment
Options:
-s, --strict Strict mode - treat warnings as errors
-e, --environment <env> Target environment (sandbox|production) (default:
"sandbox")
--json Output results as JSON
-h, --help display help for commandpsycloud mturk test
Usage: psycloud mturk test [options] <html>
Test an experiment with simulated MTurk parameters
Options:
-m, --mode <mode> Simulation mode (preview|active|outside) (default:
"active")
-p, --port <port> Server port (default: "8080")
-w, --worker <id> Worker ID (default: "TEST_WORKER_001")
-a, --assignment <id> Assignment ID (default: "TEST_ASSIGNMENT_001")
-h, --hit <id> HIT ID (default: "TEST_HIT_001")
--help display help for commandpsycloud mturk results
Usage: psycloud mturk results [options] <dataPath>
Analyze collected MTurk study data
Options:
-f, --format <format> Output format (summary|json|csv) (default: "summary")
-i, --individual Include individual worker data
-o, --output <file> Output file (for json/csv)
-h, --help display help for commandpsycloud init:pavlovia
Usage: psycloud init:pavlovia [options] [name]
Create a new Pavlovia-ready experiment from template
Options:
-n, --namespace <namespace> GitLab namespace/username for fullPath
-d, --description <desc> Experiment description (default: "A PsyCloud
experiment on Pavlovia")
-a, --author <author> Author name
--prolific <code> Prolific completion code for auto-redirect
--sona <url> SONA URL for auto-redirect
--dir <dir> Output directory (default: ".")
--copy-lib Copy psycloud-pavlovia.js to output directory
(default: true)
-h, --help display help for commandpsycloud deploy-pavlovia
Usage: psycloud deploy-pavlovia [options] <experiment>
Deploy an experiment to Pavlovia/GitLab
Options:
-u, --user <username> GitLab username (or set PAVLOVIA_LOGIN in .env)
-p, --password <password> GitLab password (or set PAVLOVIA_PASSWORD in .env)
--project <name> Project name on GitLab (defaults to experiment
name)
--namespace <namespace> GitLab namespace/group (defaults to username)
--activate Automatically activate experiment on Pavlovia
--pilot Set experiment to pilot mode
--force Force overwrite if project exists
--no-push Create local repository but do not push to GitLab
--gitlab-url <url> GitLab URL (default: "https://gitlab.pavlovia.org")
--pavlovia-url <url> Pavlovia URL (default: "https://pavlovia.org")
-h, --help display help for command