@playword/cli

Use PlayWord instantly from the command line.

📦 Installation

# Install with any package manager you prefer
npm install @playword/cli --save-dev

# Run the package directly with npx (recommended)
npx @playword/cli test --headed --verbose

📖 Available Commands

test

Run a PlayWord test step by step.

npx @playword/cli test [options]

Options

Property	Alias	Type	Default	Description
--headed	-h	bool	false	Whether to open the browser in headed mode.
--env-file	-e	string	.env	Which env file to use.
--record	-r	bool, string	false	Whether to record the test steps. You can also specify a file path to save the recording. (Must be a JSON file)
--playback	-p	string	false	Whether to playback the test steps from a recording file. This should be used with the --record option.
--use-screenshot	-s	bool	false	Whether to enable screenshot reference.
--browser	-b	string	chrome	Which browser to use. Supported values are chromium, chrome, msedge, firefox and webkit.
--verbose	-v	bool	false	Whether to enable verbose mode.
--openai-options	-o	array	[]	Additional OpenAI API options. e.g. --openai-option apiKey=sk-... baseURL=https://...
--help		bool	false	Show help information.