@playforge/cli

CLI for scaffolding and managing PlayForge Playwright projects. Part of the PlayForge framework.

Installation

npm install -g @playforge/cli

Or use directly with npx:

npx @playforge/cli init my-app

Commands

playforge init <name>

Create a new PlayForge project with the three-layer Page Object Model:

playforge init my-app
cd my-app
npm install
npx playwright install
npm test

Generated structure:

my-app/
├── src/pages/example/
│   ├── example-page.ts    # Locators only
│   └── example-steps.ts   # Business logic + assertions
├── tests/
│   └── example.spec.ts    # Test orchestration
├── playwright.config.ts
├── eslint.config.ts       # PlayForge rules enabled
├── tsconfig.json
├── package.json
└── .github/workflows/test.yml

playforge generate page <name>

Generate a page object + steps file pair:

playforge generate page login

Creates:

• src/pages/login/login-page.ts — Page object with locators
• src/pages/login/login-steps.ts — Steps with business logic

playforge generate test <name>

Generate a test spec file:

playforge generate test login

Creates:

• tests/login.spec.ts — Test spec using the steps class

Requirements

• Node.js >= 20

License

MIT