@testiumhq/cli 1.0.1

package/README.md

@@ -0,0 +1,71 @@
+# TestiumHQ CLI
+
+The official command-line interface for TestiumHQ. Record, manage, and execute automated tests directly from your terminal.
+
+## Installation
+
+Install the CLI globally using npm:
+
+```bash
+npm install -g testiumhq
+```
+
+*Requires Node.js 18 or higher.*
+
+## Getting Started
+
+Follow these steps to set up TestiumHQ in your project:
+
+### 1. Initialize Your Project
+Run this command in your project's root directory:
+
+```bash
+testiumhq init
+```
+
+This will create a `testiumhq.config.json` file and a `tests/` directory to store your recorded Playwright scripts.
+
+### 2. Login to Your Account
+Authenticate your CLI with your TestiumHQ account:
+
+```bash
+testiumhq login
+```
+
+You will be prompted to enter your **API Token**, which you can find in the TestiumHQ Dashboard.
+
+### 3. Start the Local Agent
+The agent acts as a bridge between the TestiumHQ Dashboard and your local machine. Start it to enable cloud-to-local test execution:
+
+```bash
+testiumhq agent
+```
+
+Once running, the Dashboard will detect your machine, allowing you to run and record tests locally.
+
+## Usage Commands
+
+| Command | Description |
+|---------|-------------|
+| `testiumhq init` | Initialize a new project with configuration |
+| `testiumhq login` | Authenticate with your platform account |
+| `testiumhq agent` | Start the local runner agent (Control Plane) |
+| `testiumhq sync` | Synchronize test cases from the backend |
+| `testiumhq run` | Execute local tests manually |
+
+## CI/CD Integration
+
+To run tests in CI environments (GitHub Actions, Jenkins, etc.), use the `run` command with your project ID:
+
+```bash
+testiumhq run --projectId <your-project-id>
+```
+
+Ensure your `TESTIUMHQ_TOKEN` environment variable is set in your CI configuration.
+
+## Support
+
+For issues, questions, or feedback, please visit our [Documentation](https://testiumhq.com/docs) or contact our support team.
+
+---
+© 2026 TestiumHQ. All rights reserved.