Package Exports

@withkeystone/cli
@withkeystone/cli/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@withkeystone/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Keystone Local Runner

Run Keystone tests locally against your localhost applications with visual test recording.

Installation

npm install -g @withkeystone/cli

Usage

Start the local runner:

keystone start

Options:

-p, --port <port> - WebSocket port (default: 9223)
--headless - Run browser in headless mode
--debug - Enable debug logging

How it works

The local runner starts a WebSocket server on port 9223
When you open Keystone Studio and enter a localhost URL, it automatically detects the local runner
Your localhost app is embedded in an iframe alongside the test builder
You can record actions by clicking the "Record Actions" button
Recorded actions are automatically converted to test steps

Requirements

Chrome or Chromium browser installed
Node.js 16+

Features

Visual Recording: Click "Record Actions" to automatically capture clicks, typing, and form submissions
Real-time Execution: Run test steps instantly against your local app
Network Capture: Monitor all network requests during test execution
Screenshot Support: Capture screenshots before and after each step

Limitations

Recording only works for same-origin pages (localhost)
Cross-origin sites require proxy mode (coming soon)

Development

# Install dependencies
npm install

# Build
npm run build

# Run locally
node dist/index.js start