@playerthree/cli#

Programmatic API of the playerthree CLI (use it from CI scripts or tests).

Interfaces#

AuditOptions#

Defined in: packages/cli/src/audit.ts:738

Programmatic API of the playerthree CLI (use it from CI scripts or tests).

Extended by#

• AuditSeatsOptions

Properties#

AuditReport#

Defined in: packages/cli/src/audit.ts:49

Programmatic API of the playerthree CLI (use it from CI scripts or tests).

Properties#

AuditSeat#

Defined in: packages/cli/src/audit.ts:164

Programmatic API of the playerthree CLI (use it from CI scripts or tests).

Properties#

AuditSeatsOptions#

Defined in: packages/cli/src/audit.ts:849

Programmatic API of the playerthree CLI (use it from CI scripts or tests).

Extends#

• AuditOptions

Properties#

CheckResult#

Defined in: packages/cli/src/audit.ts:38

One audit check: counts of passing and failing cases.

Properties#

CostRow#

Defined in: packages/cli/src/lint.ts:56

Properties#

DevServer#

Defined in: packages/cli/src/dev.ts:25

Properties#

Methods#

close()#

close(): Promise<void>;

Defined in: packages/cli/src/dev.ts:36

Returns#

Promise<void>

DevServerOptions#

Defined in: packages/cli/src/dev.ts:15

Listen address (default 127.0.0.1:8787), the agent's seat and the match seed (default 1).

Properties#

Finding#

Defined in: packages/cli/src/lint.ts:12

One lint result; any error fails the report.

Properties#

Io#

Defined in: packages/cli/src/main.ts:43

Output and terminal capabilities of one CLI run, injectable for tests.

Properties#

Methods#

err()#

err(text): void;

Defined in: packages/cli/src/main.ts:45

Parameters#

Returns#

void

out()#

out(text): void;

Defined in: packages/cli/src/main.ts:44

Parameters#

Returns#

void

prompt()?#

prompt?(question): Promise<string>;

Defined in: packages/cli/src/main.ts:52

Reads one answer line (required when interactive).

Parameters#

Returns#

Promise<string>

LintOptions#

Defined in: packages/cli/src/lint.ts:33

Properties#

LintReport#

Defined in: packages/cli/src/lint.ts:63

Properties#

ObservationStats#

Defined in: packages/cli/src/lint.ts:47

Properties#

Size#

Defined in: packages/cli/src/size.ts:21

Properties#

Type Aliases#

Invoke#

type Invoke = (method, args) => Promise<unknown>;

Defined in: packages/cli/src/audit.ts:162

Calls one control method with raw arguments (exactly the MCP tool argument object, e.g. { intents } for act), so malformed shapes reach the endpoint unaltered. Throws an Error with a code on a failed call.

Parameters#

Returns#

Promise<unknown>

Variables#

DEFAULT_PRICES#

const DEFAULT_PRICES: Readonly<Record<string, number>>;

Defined in: packages/cli/src/lint.ts:22

Input price per million tokens, USD. List prices checked 2026-11-02 on each provider's pricing page.

PRICES_CHECKED#

const PRICES_CHECKED: "2026-11-02" = '2026-11-02';

Defined in: packages/cli/src/lint.ts:31

Functions#

auditDefinition()#

function auditDefinition(def, opts?): Promise<AuditReport>;

Defined in: packages/cli/src/audit.ts:749

Audit a game definition on an in-process PlayerThreeHost (every role of the first team, plus local-only checks).

Parameters#

Returns#

Promise<AuditReport>

auditRemote()#

function auditRemote(
   url, 
   token, 
   opts?
): Promise<AuditReport>;

Defined in: packages/cli/src/audit.ts:810

Audit a live MCP endpoint through a seat token (the seat should be under agent control).

Parameters#

Returns#

Promise<AuditReport>

auditSeats()#

function auditSeats(seats, opts): Promise<AuditReport>;

Defined in: packages/cli/src/audit.ts:861

Audit seats reached through any binding (e.g. your own WebSocket transport): give one Invoke per seat that forwards raw tool-shaped arguments. Runs the fuzz, echo, vocabulary, schema and rate-limit checks.

Parameters#

Returns#

Promise<AuditReport>

devBanner()#

function devBanner(
   d, 
   def, 
   color?
): string;

Defined in: packages/cli/src/dev.ts:95

The terminal banner playerthree dev prints: the match, its links and harness setup for the seat.

Parameters#

Returns#

string

estimateTokens()#

function estimateTokens(text): number;

Defined in: packages/cli/src/size.ts:14

Estimated LLM tokens of text (see TOKEN_RE).

Parameters#

Returns#

number

formatAuditReport()#

function formatAuditReport(r, color?): string;

Defined in: packages/cli/src/audit.ts:888

Human-readable audit report (ANSI colours when color).

Parameters#

Returns#

string

formatLintReport()#

function formatLintReport(r, color?): string;

Defined in: packages/cli/src/lint.ts:303

Human-readable lint report (ANSI colours when color).

Parameters#

Returns#

string

lintDefinition()#

function lintDefinition(def, opts?): LintReport;

Defined in: packages/cli/src/lint.ts:235

Runs every design-time check on a game definition; ok is false when any finding is an error.

Parameters#

Returns#

LintReport

loadDefinition()#

function loadDefinition(modulePath, exportName?): Promise<GameDefinition<AnyManifest>>;

Defined in: packages/cli/src/load.ts:7

Import a game module and return its definition export (or the named export).

Parameters#

Returns#

Promise<GameDefinition<AnyManifest>>

localInvoke()#

function localInvoke(c): Invoke;

Defined in: packages/cli/src/audit.ts:173

Raw-argument invocation of an in-process SeatControl (for auditSeats).

Parameters#

Returns#

Invoke

main()#

function main(argv, io?): Promise<number>;

Defined in: packages/cli/src/main.ts:232

Runs one CLI invocation (argv without the node and script paths); resolves to the process exit code.

Parameters#

Returns#

Promise<number>

prosiness()#

function prosiness(literal): string | undefined;

Defined in: packages/cli/src/lint.ts:79

Heuristic: an enum literal "looks like prose" when it has many words or contains sentence/instruction words.

Parameters#

Returns#

string | undefined

safetyCard()#

function safetyCard(r): string;

Defined in: packages/cli/src/safety.ts:45

Renders the Safety Card markdown from an audit report.

Parameters#

Returns#

string

startDevServer()#

function startDevServer(def, opts?): Promise<DevServer>;

Defined in: packages/cli/src/dev.ts:40

Serves def on one HTTP server — MCP at /mcp, DevTools at /playerthree/devtools — with one match whose seat opts.seat is agent-controlled and has a minted seat token.

Parameters#

Returns#

Promise<DevServer>

worstCase()#

function worstCase(s): Size;

Defined in: packages/cli/src/size.ts:57

Conservative JSON encoding bound (every optional field present, every array full). Bounded text includes worst-case escaping; integer arrays use exact integer endpoint widths.

Parameters#

Returns#

Size