npm package: @tacl/runner
Description: Tacl cli to run automated tests
Author: tacl
Latest version: 0.0.52

#

```
_____             ___________
__  /______ _________  /___(_)_____
_  __/  __ `/  ___/_  / __  /_  __ \
/ /_ / /_/ // /__ _  /___  / / /_/ /
\__/ \__,_/ \___/ /_/_(_)_/  \____/
```

🚀 **Tacl CLI Runner** – A command-line interface for executing **Tacl framework** test cases.

## Prerequisites

Before you begin, ensure you have the following:

1. **Node.js:** Install from the [official website](https://nodejs.org/).
2. **Test Directory:** Create a directory for your tacl test and navigate to it through your command line interface:
3. **tacl CLI:** Install the tacl CLI:
   ```bash
   npm install @tacl/runner
   ```
4. **Playwright Browsers:** Install browser binaries by running:
   ```bash
   npx playwright install
   ```
5. **API Key:** Create an [API Key](https://docs.tacl.io/docs/guides/workspace/settings/api-keys) for authentication.
6. **Environment Variables:** Create a `.env` file in your project root and add:
   ```bash
   TACL_API_KEY=<your-api-key>
   ```

### **Run test using `npx`**

```sh
npx @tacl/runner --help
```

## **📖 Usage**

Run tests using the **Tacl CLI**:

```sh
npx @tacl/runner [options]
```

### **🔹 Available Options**

| Option                                        | Description                                      | Default        |
| --------------------------------------------- | ------------------------------------------------ | -------------- |
| `-V, --version`                               | Output the CLI version                           | -              |
| `--apiKey <key>`                              | Environment variable name containing the API key | `TACL_API_KEY` |
| `--testcaseId <Testcase Id>`                  | ID of the testcase to run                        | -              |
| `--testSuiteId <TestSuite Id>`                | ID of the test suite to run                      | -              |
| `--executionProfileId <Execution Profile Id>` | Execution profile ID to use                      | `default`      |
| `--datasetId <Dataset Id>`                    | Dataset ID to use for the test run               | `default`      |
| `--resultsPath <path>`                        | Path to save test results                        | -              |
| `-h, --help`                                  | Display help for command                         | -              |

> **Note:** Only one of `testcaseId` or `testSuiteId` can be provided.

## **📌 Examples**

### **Run a single test case with api key variable**

```sh
npx @tacl/runner --apiKey YOUR_API_KEY --testcaseId 12345
```

### **Run a test suite with an execution profile**

```sh
npx @tacl/runner --testSuiteId 67890 --executionProfileId 98765
```

### **Change results path**

```sh
npx @tacl/runner --testcaseId 12345 --resultsPath my-results
```

## **📜 License**

This project is licensed under the **Apache-2.0 License**.

## **🛠 Support & Community**

If you encounter any issues, please open an issue on **[GitHub](https://github.com/taclio/tacl.io/issues)**.

### 💬 **Join Our Community**

Connect with other users and get support:  
[![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/qw6DqkZ4VR)

### 🌐 **Follow Us**

Stay updated with the latest news and updates:  
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/taclio)  
[![X (Twitter)](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/tacl_io)  
[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@taclio)