Skip to main content
userplay is a command-line client for the public API. It reaches every studio your account belongs to: playtests, players, key vaults, sessions, and results. The npm package is @userplaylabs/cli; the binary is userplay.

Install

Requires Node.js 20 or newer.

Get started

The quickstart walks from install through your first write. The short version:

Getting help

--help works at every level. It prints arguments, flags, and examples for whatever you point it at:

How commands read

Commands name a resource, then an action, then take arguments and flags. Writes are guarded: they confirm before hitting production, and --dry-run shows the request without sending it. The command reference lists every command in full.

Next steps

Quickstart

From install to your first write.

Authentication

Log in, switch accounts, and use a key in CI.

Global options

Agent mode, JSON output, dry runs, and write guards.

Command reference

Every command, argument, and flag.