Table of Contents

Getting Started

📦 Installation

To install TeaPie CLI, run:

dotnet tool install -g TeaPie.Tool

To integrate tool within your project, use:

dotnet add package TeaPie

🤖 Or try your AI Agent

You can use your AI agent to automatically set up TeaPie in your project. Copy and paste the following prompt:

Set up TeaPie in this project by following these steps:

1. Download the TeaPie skill from the GitHub repository into this project.
   - Skill location: https://github.com/Kros-sk/TeaPie/tree/master/.cursor/skills/teapie/
   - Determine the target location based on the IDE:
     * For Cursor: .cursor/skills/teapie/
     * For VS Code: .github/skills/teapie/
     * For other IDEs: use standard conventions for that IDE
   - Download the entire teapie directory (including SKILL.md and all subdirectories with their contents: references/, scripts/, templates/) and copy it to the correct target location.

2. Install TeaPie.Tool globally using:
   dotnet tool install -g TeaPie.Tool

3. Initialize TeaPie configuration by running:
   teapie init

4. Ask the user if they want to create their first TeaPie tests. If yes, use the TeaPie skill knowledge to help create appropriate test cases based on their project structure and needs.

⚡ Quick Start

1️⃣ Create a New Test Case

teapie generate <test-case-name>

To learn more about test cases, visit the Test Case page.

2️⃣ Run All Test Cases in a Collection

teapie test ./demo/Tests

Not sure what a collection is? Read about collections.

3️⃣ Execute a Single Test Case

teapie test "./demo/Tests/002-Cars/002-Edit-Car-req.http"

Whether you want to run single test case or collection, read more.

Edit this page