@supercheck/cli 0.1.1-beta.2 → 0.1.1-beta.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.
Files changed (4) hide show
  1. package/README.md +30 -19
  2. package/dist/bin/supercheck.js +293 -74
  3. package/dist/bin/supercheck.js.map +1 -1
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -13,6 +13,8 @@ The Supercheck CLI provides a first-class command-line interface for managing yo
13
13
  - **CI/CD Integration**: Trigger jobs and wait for results directly from your pipeline.
14
14
  - **Full Resource Management**: Manage all resources (tests, monitors, jobs, variables, tags, notifications) from the terminal.
15
15
  - **Local Development**: Run and debug tests locally before deploying.
16
+ - **Security-First**: Token scanning in config files, SHA-256 hashed storage, prefix-validated authentication.
17
+ - **Proxy Support**: Full HTTP/HTTPS proxy support with `NO_PROXY` awareness via `undici`.
16
18
 
17
19
  ## Installation
18
20
 
@@ -68,12 +70,12 @@ supercheck upgrade
68
70
 
69
71
  6. **Run tests locally (optional)**:
70
72
  ```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
73
+ supercheck test run --file _supercheck_/playwright/homepage-check.<id>.pw.ts
74
+ supercheck test run --all --type browser
75
+ supercheck test run --all --type performance
76
+ supercheck test run --all --type api
77
+ supercheck test run --all --type database
78
+ supercheck test run --all --type custom
77
79
  ```
78
80
 
79
81
  For remote execution with persisted run history, trigger a job:
@@ -102,7 +104,7 @@ supercheck upgrade
102
104
  | `supercheck diff` | Preview changes between local config and cloud |
103
105
  | `supercheck deploy` | Apply local config changes to the cloud |
104
106
  | `supercheck validate` | Validate local test scripts (same rules as Playground) |
105
- | `supercheck destroy --force` | Remove all managed resources from the cloud |
107
+ | `supercheck destroy` | Remove all managed resources from the cloud (`--dry-run`, `--force`) |
106
108
  | `supercheck config validate` | Validate your `supercheck.config.ts` |
107
109
  | `supercheck config print` | Print resolved `supercheck.config.ts` |
108
110
 
@@ -114,8 +116,8 @@ supercheck upgrade
114
116
  |---|---|
115
117
  | `supercheck job list` | List all jobs |
116
118
  | `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 create --name <name> --tests <test-id...>` | Create a new job with tests (`--dry-run`) |
120
+ | `supercheck job update <id> --name ...` | Update job fields (`--dry-run`) |
119
121
  | `supercheck job delete <id>` | Delete a job |
120
122
  | `supercheck job keys <jobId>` | List trigger keys for a job |
121
123
  | `supercheck job keys create <jobId> --name <name>` | Create a trigger key |
@@ -123,7 +125,7 @@ supercheck upgrade
123
125
  | `supercheck job run --id <job-id>` | Run a job immediately |
124
126
  | `supercheck job run --local` | Run a job locally using local test files |
125
127
  | `supercheck job trigger <id> --wait` | Trigger a job and wait for completion (CI/CD) |
126
- | `supercheck run list` | List recent execution runs |
128
+ | `supercheck run list` | List recent execution runs (`--job`, `--status`, `--page`, `--limit`) |
127
129
  | `supercheck run get <id>` | Get run details |
128
130
  | `supercheck run status <id>` | Get run status |
129
131
  | `supercheck run permissions <id>` | Get run permissions |
@@ -134,10 +136,10 @@ supercheck upgrade
134
136
 
135
137
  | Command | Description |
136
138
  |---|---|
137
- | `supercheck test list` | List all tests |
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 |
139
+ | `supercheck test list` | List all tests (`--search`, `--type`, `--page`, `--limit`) |
140
+ | `supercheck test get <id>` | Get test details (`--include-script`) |
141
+ | `supercheck test create` | Create a new test (`--dry-run`) |
142
+ | `supercheck test update <id>` | Update a test (`--dry-run`) |
141
143
  | `supercheck test delete <id>` | Delete a test |
142
144
  | `supercheck test validate` | Validate local test scripts (same rules as Playground) |
143
145
  | `supercheck test run` | Run tests locally |
@@ -148,11 +150,13 @@ supercheck upgrade
148
150
  | `supercheck monitor results <id>` | Get monitor check results |
149
151
  | `supercheck monitor stats <id>` | Get monitor statistics |
150
152
  | `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 create ...` | Create a monitor (`--interval-minutes`, `--dry-run`) |
154
+ | `supercheck monitor update <id> ...` | Update a monitor (`--interval-minutes`, `--dry-run`) |
153
155
  | `supercheck monitor delete <id>` | Delete a monitor |
154
156
 
155
- `supercheck test run` is local-only. `--cloud`, `--id`, and `--location` are deprecated for direct test execution.
157
+ > **Dry run support:** `test create`, `test update`, `job create`, `job update`, `monitor create`, `monitor update`, and `deploy` all support `--dry-run` to preview the API payload without making changes.
158
+
159
+ `supercheck test run` is local-only. Cloud test execution has been replaced by `supercheck job run` / `supercheck job trigger`.
156
160
 
157
161
  ### Variables, Tags & Notifications
158
162
 
@@ -170,7 +174,7 @@ supercheck upgrade
170
174
  |---|---|
171
175
  | `supercheck health` | Check API health |
172
176
  | `supercheck locations` | List available execution locations |
173
- | `supercheck doctor` | Validate local CLI dependencies and config |
177
+ | `supercheck doctor` | Validate local CLI dependencies and config (`--fix`) |
174
178
  | `supercheck upgrade` | Upgrade the CLI to the latest release |
175
179
 
176
180
  ## Configuration
@@ -235,6 +239,11 @@ test:
235
239
  | `SUPERCHECK_TOKEN` | CLI token for authentication (CI/CD) |
236
240
  | `SUPERCHECK_TRIGGER_KEY` | Trigger key for `job trigger` |
237
241
  | `SUPERCHECK_URL` | Custom API URL (self-hosted) |
242
+ | `SUPERCHECK_ORG` | Override organization ID from config |
243
+ | `SUPERCHECK_PROJECT` | Override project ID from config |
244
+ | `HTTPS_PROXY` | Proxy URL for HTTPS requests |
245
+ | `HTTP_PROXY` | Proxy URL for HTTP requests |
246
+ | `NO_PROXY` | Hosts to bypass proxy (comma-separated) |
238
247
 
239
248
  ## Global Options
240
249
 
@@ -243,10 +252,12 @@ test:
243
252
  | `--json` | Output in JSON format |
244
253
  | `--quiet` | Suppress non-essential output |
245
254
  | `--debug` | Enable debug logging |
255
+ | `--config <path>` | Path to config file (for config-aware commands) |
246
256
  | `-v, --version` | Show CLI version |
247
257
 
248
258
  ## Links
249
259
 
250
260
  - [Website](https://supercheck.io)
251
- - [Documentation](https://supercheck.io/docs/app/welcome)
261
+ - [CLI Documentation](https://supercheck.io/docs/cli/commands)
262
+ - [App Documentation](https://supercheck.io/docs/app/welcome)
252
263
  - [GitHub](https://github.com/supercheck-io/supercheck)