@supercheck/cli 0.1.0-beta.9 → 0.1.1-beta.2

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 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
- This creates a `supercheck.config.ts` and a `_supercheck_` directory with example tests.
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,29 @@ 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
+ For remote execution with persisted run history, trigger a job:
80
+ ```bash
81
+ supercheck job run --id <job-id>
82
+ # or (CI/CD trigger key flow)
83
+ supercheck job trigger <job-id> --wait
84
+ ```
85
+
54
86
  ## Command Reference
55
87
 
56
88
  ### Authentication
@@ -69,29 +101,58 @@ npx @supercheck/cli --help
69
101
  | `supercheck pull` | Sync cloud resources to local config |
70
102
  | `supercheck diff` | Preview changes between local config and cloud |
71
103
  | `supercheck deploy` | Apply local config changes to the cloud |
104
+ | `supercheck validate` | Validate local test scripts (same rules as Playground) |
72
105
  | `supercheck destroy --force` | Remove all managed resources from the cloud |
73
106
  | `supercheck config validate` | Validate your `supercheck.config.ts` |
107
+ | `supercheck config print` | Print resolved `supercheck.config.ts` |
108
+
109
+ > Note: In the current API, status pages are readable/deletable from CLI sync flows, but create/update endpoints are not available.
74
110
 
75
111
  ### Jobs & Runs
76
112
 
77
113
  | Command | Description |
78
114
  |---|---|
79
115
  | `supercheck job list` | List all jobs |
80
- | `supercheck job create` | Create a new job |
81
- | `supercheck job run` | Run a job immediately |
116
+ | `supercheck job get <id>` | Get job details |
117
+ | `supercheck job create --name <name> --tests <test-id...>` | Create a new job with tests |
118
+ | `supercheck job update <id> --name ...` | Update job fields |
119
+ | `supercheck job delete <id>` | Delete a job |
120
+ | `supercheck job keys <jobId>` | List trigger keys for a job |
121
+ | `supercheck job keys create <jobId> --name <name>` | Create a trigger key |
122
+ | `supercheck job keys delete <jobId> <keyId>` | Revoke a trigger key |
123
+ | `supercheck job run --id <job-id>` | Run a job immediately |
124
+ | `supercheck job run --local` | Run a job locally using local test files |
82
125
  | `supercheck job trigger <id> --wait` | Trigger a job and wait for completion (CI/CD) |
83
126
  | `supercheck run list` | List recent execution runs |
127
+ | `supercheck run get <id>` | Get run details |
128
+ | `supercheck run status <id>` | Get run status |
129
+ | `supercheck run permissions <id>` | Get run permissions |
84
130
  | `supercheck run stream <id>` | Stream live console output |
131
+ | `supercheck run cancel <id>` | Cancel a running execution |
85
132
 
86
133
  ### Tests & Monitors
87
134
 
88
135
  | Command | Description |
89
136
  |---|---|
90
137
  | `supercheck test list` | List all tests |
91
- | `supercheck test create` | Create a new test |
92
- | `supercheck test validate` | Validate local test scripts |
138
+ | `supercheck test get <id>` | Get test details |
139
+ | `supercheck test create` | Create a new test (browser, performance, api, database, custom) |
140
+ | `supercheck test update <id>` | Update a test |
141
+ | `supercheck test delete <id>` | Delete a test |
142
+ | `supercheck test validate` | Validate local test scripts (same rules as Playground) |
143
+ | `supercheck test run` | Run tests locally |
144
+ | `supercheck test tags <id>` | List tags for a test |
145
+ | `supercheck test status <id>` | Stream live status events for a test |
93
146
  | `supercheck monitor list` | List all monitors |
94
- | `supercheck monitor status <id>` | Check real-time monitor status |
147
+ | `supercheck monitor get <id>` | Get monitor details |
148
+ | `supercheck monitor results <id>` | Get monitor check results |
149
+ | `supercheck monitor stats <id>` | Get monitor statistics |
150
+ | `supercheck monitor status <id>` | Get current monitor status |
151
+ | `supercheck monitor create ...` | Create a monitor |
152
+ | `supercheck monitor update <id> ...` | Update a monitor |
153
+ | `supercheck monitor delete <id>` | Delete a monitor |
154
+
155
+ `supercheck test run` is local-only. `--cloud`, `--id`, and `--location` are deprecated for direct test execution.
95
156
 
96
157
  ### Variables, Tags & Notifications
97
158
 
@@ -99,7 +160,7 @@ npx @supercheck/cli --help
99
160
  |---|---|
100
161
  | `supercheck var list / get / set / delete` | Manage project variables |
101
162
  | `supercheck tag list / create / delete` | Manage tags |
102
- | `supercheck notification list / delete` | Manage notification providers |
163
+ | `supercheck notification list / get / create / update / delete / test` | Manage notification providers |
103
164
  | `supercheck alert history` | View alert history |
104
165
  | `supercheck audit` | View audit logs (admin) |
105
166
 
@@ -109,6 +170,8 @@ npx @supercheck/cli --help
109
170
  |---|---|
110
171
  | `supercheck health` | Check API health |
111
172
  | `supercheck locations` | List available execution locations |
173
+ | `supercheck doctor` | Validate local CLI dependencies and config |
174
+ | `supercheck upgrade` | Upgrade the CLI to the latest release |
112
175
 
113
176
  ## Configuration
114
177
 
@@ -125,10 +188,10 @@ export default defineConfig({
125
188
  },
126
189
  tests: {
127
190
  playwright: {
128
- testMatch: '_supercheck_/tests/**/*.pw.ts',
191
+ testMatch: '_supercheck_/playwright/**/*.pw.ts',
129
192
  },
130
193
  k6: {
131
- testMatch: '_supercheck_/tests/**/*.k6.ts',
194
+ testMatch: '_supercheck_/k6/**/*.k6.ts',
132
195
  },
133
196
  },
134
197
  monitors: [