@testiumhq/cli 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ The official command-line interface for TestiumHQ. Record, manage, and execute a
|
|
|
7
7
|
Install the CLI globally using npm:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npm install -g testiumhq
|
|
10
|
+
npm install -g @testiumhq/cli
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
*Requires Node.js 18 or higher.*
|
|
@@ -20,7 +20,7 @@ Follow these steps to set up TestiumHQ in your project:
|
|
|
20
20
|
Run this command in your project's root directory:
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
|
|
23
|
+
testium init
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
This will create a `testiumhq.config.json` file and a `tests/` directory to store your recorded Playwright scripts.
|
|
@@ -29,7 +29,7 @@ This will create a `testiumhq.config.json` file and a `tests/` directory to stor
|
|
|
29
29
|
Authenticate your CLI with your TestiumHQ account:
|
|
30
30
|
|
|
31
31
|
```bash
|
|
32
|
-
|
|
32
|
+
testium login
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
You will be prompted to enter your **API Token**, which you can find in the TestiumHQ Dashboard.
|
|
@@ -38,7 +38,7 @@ You will be prompted to enter your **API Token**, which you can find in the Test
|
|
|
38
38
|
The agent acts as a bridge between the TestiumHQ Dashboard and your local machine. Start it to enable cloud-to-local test execution:
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
|
-
|
|
41
|
+
testium agent
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
Once running, the Dashboard will detect your machine, allowing you to run and record tests locally.
|
|
@@ -47,18 +47,18 @@ Once running, the Dashboard will detect your machine, allowing you to run and re
|
|
|
47
47
|
|
|
48
48
|
| Command | Description |
|
|
49
49
|
|---------|-------------|
|
|
50
|
-
| `
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
50
|
+
| `testium init` | Initialize a new project with configuration |
|
|
51
|
+
| `testium login` | Authenticate with your platform account |
|
|
52
|
+
| `testium agent` | Start the local runner agent (Control Plane) |
|
|
53
|
+
| `testium sync` | Synchronize test cases from the backend |
|
|
54
|
+
| `testium run` | Execute local tests manually |
|
|
55
55
|
|
|
56
56
|
## CI/CD Integration
|
|
57
57
|
|
|
58
58
|
To run tests in CI environments (GitHub Actions, Jenkins, etc.), use the `run` command with your project ID:
|
|
59
59
|
|
|
60
60
|
```bash
|
|
61
|
-
|
|
61
|
+
testium run --projectId <your-project-id>
|
|
62
62
|
```
|
|
63
63
|
|
|
64
64
|
Ensure your `TESTIUMHQ_TOKEN` environment variable is set in your CI configuration.
|