Agents CLI

A simple CLI tool to bootstrap production-ready Playwright automation frameworks for UI and API testing.

Installation

Option 1: Using npx (No installation required)

npx agents-cli-automation init

Option 2: Install globally via npm

npm install -g agents-cli-automation
agents init

Option 3: Install locally in a project

npm install agents-cli-automation
npx agents init

Quick Start

Run the setup command and follow the interactive prompts:

npx agents-cli-automation init

Step 1: Select Framework Type

Choose your testing type:

1. Playwright UI Testing - Browser automation, E2E tests, component testing
2. Playwright API Testing - REST API tests, integration testing, backend validation

Step 2: Select Your Language (for UI Testing)

Choose your preferred language:

• TypeScript (Recommended) - Latest & Type Safe
• JavaScript - ES Modules, modern syntax
• Java - Maven + JUnit5
• C# - NUnit + .NET

Your scalable, production-ready framework will be generated automatically!

Available Agents

📊 Playwright UI Testing Framework

Creates a production-ready Playwright framework for UI automation with support for TypeScript, JavaScript, Java, and C#.

Core Features:

• ✅ Page Object Model (POM) - Reusable page classes with best practices
• ✅ Fixtures & Setup - Built-in browser lifecycle management
• ✅ Parallel Execution - Run tests simultaneously (4 workers by default)
• ✅ Chromium Only - Single browser for consistency and speed
• ✅ Test Data Readers - Support for JSON, CSV, and YAML files
• ✅ Form Helpers - Handle dropdowns, radio buttons, checkboxes, text inputs
• ✅ BDD Support - Cucumber/Gherkin feature files for scenario-based testing
• ✅ Latest APIs - Uses latest Playwright versions with full type safety

Language Options:

• TypeScript - Full tsconfig with strict mode and path aliases (@pages/@utils/@fixtures/@data)
• JavaScript - ES Modules with modern syntax (no build step required)
• Java - Maven-based structure with JUnit 5 and all dependencies
• C# - .NET 8 with NUnit and async/await patterns

🔌 Playwright API Testing

Creates a production-ready Playwright framework for API automation with:

• ✅ Complete API test project structure
• ✅ REST API request handling
• ✅ Response validation templates
• ✅ Authentication fixtures
• ✅ Database integration helpers
• ✅ Sample API tests (GET, POST, etc.)
• ✅ CI/CD ready configuration

The generated agent will include everything you need to start automating tests immediately!

What Gets Created

When you run agents init, a .github/agents directory is created in your project with language-specific framework files.

For UI Testing (Choose Your Language)

TypeScript

• playwright-ui-testing-typescript-agent.md
  • Complete TypeScript framework with strict type checking
  • tsconfig.json with path aliases
  • Full type definitions for all utilities
  • ES2020 module syntax

JavaScript

• playwright-ui-testing-javascript-es-modules-agent.md
  • Modern ES Modules syntax (Node.js 18+)
  • No build step required
  • Same features as TypeScript without type annotations

Java

• playwright-ui-testing-java-agent.md
  • Maven-based project structure
  • JUnit 5 test framework
  • Complete pom.xml with all dependencies
  • Maven parallel execution support

C#

• playwright-ui-testing-c#-agent.md
  • .NET 8+ project structure
  • NUnit test framework
  • Complete .csproj configuration
  • Async/await patterns throughout

For API Testing

• playwright-api-testing-agent.md - Complete API framework setup

Framework Structure (All Languages)

Each generated framework includes:

📂 Project Structure

framework/
├── pages/               # Page Object Model classes
├── utils/              # DataReader, FormHelper, TestDataManager
├── fixtures/           # Browser setup and fixtures
├── tests/              # Test files
├── features/           # Gherkin/BDD scenarios
├── data/               # Test data (JSON, CSV, YAML)
├── config files        # Language-specific (tsconfig.json, pom.xml, etc.)
└── Sample tests        # Working examples ready to run

✨ Included in Every Framework:

• Page Object Model classes with selectors
• Form helpers for complex form interactions
• Test data readers for JSON, CSV, YAML
• BDD/Gherkin feature files
• Browser fixtures with proper cleanup
• Parallel execution configuration
• Sample tests with SauceDemo app
• Complete setup and run instructions

Requirements

To Run CLI

• Node.js 18+
• npm or yarn

To Run Generated Frameworks

TypeScript & JavaScript:

• Node.js 18+
• npm or yarn

Java:

• Java 11+
• Maven 3.8+

C#:

• .NET 8 SDK
• Visual Studio 2022 or VS Code with C# extension

Why Choose This Framework?

✅ Multi-Language Support - Use TypeScript, JavaScript, Java, or C# ✅ Minimal Setup - Fully scaffolded projects, developers focus on tests, not setup ✅ Page Object Model - Reusable, maintainable test code patterns ✅ Scalable Architecture - Ready for enterprise-grade test suites ✅ Parallel Execution - Run tests faster across multiple workers ✅ BDD Ready - Cucumber/Gherkin support for business-readable scenarios ✅ Test Data Management - JSON, CSV, YAML support out of the box ✅ Form Helpers - Handle complex forms, dropdowns, checkboxes easily ✅ Latest Playwright - Always using cutting-edge Playwright features ✅ Production Ready - Fixtures, proper cleanup, error handling included

Framework Quick Features

Each generated framework provides:

For UI Testing:

• SauceDemo test examples (login, shopping cart)
• Complete page objects with all selectors
• Form interaction helpers for any element type
• Test data loading from multiple formats
• BDD scenario examples with step definitions
• Parallel execution (4 workers by default)
• Chromium-only for reliability

For API Testing:

• Writing GET, POST, PUT, DELETE tests
• Response validation patterns
• Authentication and headers setup
• Environment variables configuration
• Database integration examples

Happy automating! 🚀