spec-kit

⚡ spec-kit is a smart CLI scaffolding tool that generates production-ready, spec-driven test automation project structures interactively.

Supported Frameworks

• Playwright (TypeScript/JavaScript)
• Cypress (TypeScript/JavaScript)
• Python API Testing (OpenAPI/Schemathesis driven)

Features

• Spec-Driven BDD Architecture: All frameworks scaffold a pristine features/ -> scenarios/ -> tests/ structure separating intent from implementation.
• Interactive Scaffolding: Built with inquirer for a smooth DX.
• Dynamic Config: Automatically installs test dependencies, hooks up Playwright-BDD / Cypress-BDD, and structures Pytest for API testing.
• CI & Docker: Built-in GitHub Actions templates and Dockerfiles.
• Reporting: First-class support for Allure, HTML plugins, and Mochawesome (Cypress).

Usage

You can run spec-kit immediately via npx:

npx @aigenerated/spec-kit init

Wait for the prompts, select your framework, set your options, and spec-kit will build a complete end-to-end testing repository for you instantly.

Playwright Structure Example

When scaffolding Playwright, spec-kit leverages playwright-bdd giving native Cucumber support with Playwright runners and assertions. It generates Page Objects, world fixtures, isolated test data, and sample scenarios (Authentication, Checkout, Search).

Cypress Structure Example

Cypress generation utilizes the official @badeball/cypress-cucumber-preprocessor with esbuild for blazingly fast parsing. Provides clean custom commands and Page Object structural separation.

Python API Structure Example

Generates a pure spec-driven API suite reading directly from openapi.yaml. Uses schemathesis to automatically contract-test every endpoint in the OpenAPI document, layered with pytest-bdd for functional end-to-end workflows and a robust wrapped API Client (using requests or httpx).

Local Development

git clone https://github.com/test-forge/test-forge.git
cd spec-kit
npm install
npm link
spec-kit init