_____ ___________
__ /______ _________ /___(_)_____
_ __/ __ `/ ___/_ / __ /_ __ \
/ /_ / /_/ // /__ _ /___ / / /_/ /
\__/ \__,_/ \___/ /_/_(_)_/ \____/
🚀 Tacl CLI Runner – A command-line interface for executing Tacl framework test cases.
Prerequisites
Before you begin, ensure you have the following:
- Node.js: Install from the official website.
- Test Directory: Create a directory for your tacl test and navigate to it through your command line interface:
- tacl CLI: Install the tacl CLI:
npm install @tacl/runner
- Playwright Browsers: Install browser binaries by running:
npx playwright install
- API Key: Create an API Key for authentication.
- Environment Variables: Create a
.env file in your project root and add:
TACL_API_KEY=<your-api-key>
Run test using npx
npx @tacl/runner --help
📖 Usage
Run tests using the Tacl CLI:
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
npx @tacl/runner --apiKey YOUR_API_KEY --testcaseId 12345
Run a test suite with an execution profile
npx @tacl/runner --testSuiteId 67890 --executionProfileId 98765
Change results path
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.
💬 Join Our Community
Connect with other users and get support:
🌐 Follow Us
Stay updated with the latest news and updates:
