@supercheck/cli 0.1.0-beta.8 → 0.1.1-beta.1
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 +40 -6
- package/dist/bin/supercheck.js +1294 -277
- package/dist/bin/supercheck.js.map +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -26,13 +26,22 @@ Or run directly with `npx`:
|
|
|
26
26
|
npx @supercheck/cli --help
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
+
## Upgrade
|
|
30
|
+
|
|
31
|
+
Upgrade the CLI to the latest release:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
supercheck upgrade
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
|
|
29
38
|
## Quick Start
|
|
30
39
|
|
|
31
40
|
1. **Initialize a new project**:
|
|
32
41
|
```bash
|
|
33
42
|
supercheck init
|
|
34
43
|
```
|
|
35
|
-
|
|
44
|
+
This creates a `supercheck.config.ts` and a `_supercheck_` directory with example tests under `_supercheck_/playwright` and `_supercheck_/k6`.
|
|
36
45
|
|
|
37
46
|
2. **Authenticate**:
|
|
38
47
|
```bash
|
|
@@ -51,6 +60,27 @@ npx @supercheck/cli --help
|
|
|
51
60
|
supercheck deploy
|
|
52
61
|
```
|
|
53
62
|
|
|
63
|
+
5. **Validate scripts**:
|
|
64
|
+
```bash
|
|
65
|
+
supercheck validate
|
|
66
|
+
```
|
|
67
|
+
Validation runs automatically during deploy and cannot be skipped.
|
|
68
|
+
|
|
69
|
+
6. **Run tests locally (optional)**:
|
|
70
|
+
```bash
|
|
71
|
+
supercheck test run --local --file _supercheck_/playwright/homepage-check.<id>.pw.ts
|
|
72
|
+
supercheck test run --local --all --type browser
|
|
73
|
+
supercheck test run --local --all --type performance
|
|
74
|
+
supercheck test run --local --all --type api
|
|
75
|
+
supercheck test run --local --all --type database
|
|
76
|
+
supercheck test run --local --all --type custom
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**Run tests in the cloud**:
|
|
80
|
+
```bash
|
|
81
|
+
supercheck test run --cloud --id <test-id>
|
|
82
|
+
```
|
|
83
|
+
|
|
54
84
|
## Command Reference
|
|
55
85
|
|
|
56
86
|
### Authentication
|
|
@@ -69,6 +99,7 @@ npx @supercheck/cli --help
|
|
|
69
99
|
| `supercheck pull` | Sync cloud resources to local config |
|
|
70
100
|
| `supercheck diff` | Preview changes between local config and cloud |
|
|
71
101
|
| `supercheck deploy` | Apply local config changes to the cloud |
|
|
102
|
+
| `supercheck validate` | Validate local test scripts (same rules as Playground) |
|
|
72
103
|
| `supercheck destroy --force` | Remove all managed resources from the cloud |
|
|
73
104
|
| `supercheck config validate` | Validate your `supercheck.config.ts` |
|
|
74
105
|
|
|
@@ -77,8 +108,9 @@ npx @supercheck/cli --help
|
|
|
77
108
|
| Command | Description |
|
|
78
109
|
|---|---|
|
|
79
110
|
| `supercheck job list` | List all jobs |
|
|
80
|
-
| `supercheck job create
|
|
111
|
+
| `supercheck job create --name <name> --tests <test-id...>` | Create a new job with tests |
|
|
81
112
|
| `supercheck job run` | Run a job immediately |
|
|
113
|
+
| `supercheck job run --local` | Run a job locally using local test files |
|
|
82
114
|
| `supercheck job trigger <id> --wait` | Trigger a job and wait for completion (CI/CD) |
|
|
83
115
|
| `supercheck run list` | List recent execution runs |
|
|
84
116
|
| `supercheck run stream <id>` | Stream live console output |
|
|
@@ -88,8 +120,9 @@ npx @supercheck/cli --help
|
|
|
88
120
|
| Command | Description |
|
|
89
121
|
|---|---|
|
|
90
122
|
| `supercheck test list` | List all tests |
|
|
91
|
-
| `supercheck test create` | Create a new test |
|
|
92
|
-
| `supercheck test validate` | Validate local test scripts |
|
|
123
|
+
| `supercheck test create` | Create a new test (browser, performance, api, database, custom) |
|
|
124
|
+
| `supercheck test validate` | Validate local test scripts (same rules as Playground) |
|
|
125
|
+
| `supercheck test run` | Run tests locally or in the cloud |
|
|
93
126
|
| `supercheck monitor list` | List all monitors |
|
|
94
127
|
| `supercheck monitor status <id>` | Check real-time monitor status |
|
|
95
128
|
|
|
@@ -109,6 +142,7 @@ npx @supercheck/cli --help
|
|
|
109
142
|
|---|---|
|
|
110
143
|
| `supercheck health` | Check API health |
|
|
111
144
|
| `supercheck locations` | List available execution locations |
|
|
145
|
+
| `supercheck upgrade` | Upgrade the CLI to the latest release |
|
|
112
146
|
|
|
113
147
|
## Configuration
|
|
114
148
|
|
|
@@ -125,10 +159,10 @@ export default defineConfig({
|
|
|
125
159
|
},
|
|
126
160
|
tests: {
|
|
127
161
|
playwright: {
|
|
128
|
-
testMatch: '_supercheck_/
|
|
162
|
+
testMatch: '_supercheck_/playwright/**/*.pw.ts',
|
|
129
163
|
},
|
|
130
164
|
k6: {
|
|
131
|
-
testMatch: '_supercheck_/
|
|
165
|
+
testMatch: '_supercheck_/k6/**/*.k6.ts',
|
|
132
166
|
},
|
|
133
167
|
},
|
|
134
168
|
monitors: [
|