@supercheck/cli 0.1.1-beta.2 → 0.1.1-rc.1

package/README.md

@@ -13,6 +13,8 @@ The Supercheck CLI provides a first-class command-line interface for managing yo
 - **CI/CD Integration**: Trigger jobs and wait for results directly from your pipeline.
 - **Full Resource Management**: Manage all resources (tests, monitors, jobs, variables, tags, notifications) from the terminal.
 - **Local Development**: Run and debug tests locally before deploying.
+- **Security-First**: Token scanning in config files, SHA-256 hashed storage, prefix-validated authentication.
+- **Proxy Support**: Full HTTP/HTTPS proxy support with `NO_PROXY` awareness via `undici`.
 
 ## Installation
 
@@ -34,6 +36,15 @@ Upgrade the CLI to the latest release:
 supercheck upgrade
 ```
 
+## Release Channels
+
+The npm package page defaults to the `latest` dist-tag. Prerelease versions (for example, `-rc.x`) are still visible when published with the `latest` tag.
+
+```bash
+npm view @supercheck/cli dist-tags
+npm publish --tag latest --access public
+npm dist-tag add @supercheck/cli@<version> rc
+```
 
 ## Quick Start
 
@@ -68,12 +79,12 @@ supercheck upgrade
 
 6. **Run tests locally (optional)**:
   ```bash
-  supercheck test run --local --file _supercheck_/playwright/homepage-check.<id>.pw.ts
-  supercheck test run --local --all --type browser
-  supercheck test run --local --all --type performance
-  supercheck test run --local --all --type api
-  supercheck test run --local --all --type database
-  supercheck test run --local --all --type custom
+  supercheck test run --file _supercheck_/playwright/homepage-check.<id>.pw.ts
+  supercheck test run --all --type browser
+  supercheck test run --all --type performance
+  supercheck test run --all --type api
+  supercheck test run --all --type database
+  supercheck test run --all --type custom
   ```
 
   For remote execution with persisted run history, trigger a job:
@@ -102,7 +113,7 @@ supercheck upgrade
 | `supercheck diff` | Preview changes between local config and cloud |
 | `supercheck deploy` | Apply local config changes to the cloud |
 | `supercheck validate` | Validate local test scripts (same rules as Playground) |
-| `supercheck destroy --force` | Remove all managed resources from the cloud |
+| `supercheck destroy` | Remove all managed resources from the cloud (`--dry-run`, `--force`) |
 | `supercheck config validate` | Validate your `supercheck.config.ts` |
 | `supercheck config print` | Print resolved `supercheck.config.ts` |
 
@@ -114,8 +125,8 @@ supercheck upgrade
 |---|---|
 | `supercheck job list` | List all jobs |
 | `supercheck job get <id>` | Get job details |
-| `supercheck job create --name <name> --tests <test-id...>` | Create a new job with tests |
-| `supercheck job update <id> --name ...` | Update job fields |
+| `supercheck job create --name <name> --tests <test-id...>` | Create a new job with tests (`--dry-run`) |
+| `supercheck job update <id> --name ...` | Update job fields (`--dry-run`) |
 | `supercheck job delete <id>` | Delete a job |
 | `supercheck job keys <jobId>` | List trigger keys for a job |
 | `supercheck job keys create <jobId> --name <name>` | Create a trigger key |
@@ -123,7 +134,7 @@ supercheck upgrade
 | `supercheck job run --id <job-id>` | Run a job immediately |
 | `supercheck job run --local` | Run a job locally using local test files |
 | `supercheck job trigger <id> --wait` | Trigger a job and wait for completion (CI/CD) |
-| `supercheck run list` | List recent execution runs |
+| `supercheck run list` | List recent execution runs (`--job`, `--status`, `--page`, `--limit`) |
 | `supercheck run get <id>` | Get run details |
 | `supercheck run status <id>` | Get run status |
 | `supercheck run permissions <id>` | Get run permissions |
@@ -134,10 +145,10 @@ supercheck upgrade
 
 | Command | Description |
 |---|---|
-| `supercheck test list` | List all tests |
-| `supercheck test get <id>` | Get test details |
-| `supercheck test create` | Create a new test (browser, performance, api, database, custom) |
-| `supercheck test update <id>` | Update a test |
+| `supercheck test list` | List all tests (`--search`, `--type`, `--page`, `--limit`) |
+| `supercheck test get <id>` | Get test details (`--include-script`) |
+| `supercheck test create` | Create a new test (`--dry-run`) |
+| `supercheck test update <id>` | Update a test (`--dry-run`) |
 | `supercheck test delete <id>` | Delete a test |
 | `supercheck test validate` | Validate local test scripts (same rules as Playground) |
 | `supercheck test run` | Run tests locally |
@@ -148,11 +159,13 @@ supercheck upgrade
 | `supercheck monitor results <id>` | Get monitor check results |
 | `supercheck monitor stats <id>` | Get monitor statistics |
 | `supercheck monitor status <id>` | Get current monitor status |
-| `supercheck monitor create ...` | Create a monitor |
-| `supercheck monitor update <id> ...` | Update a monitor |
+| `supercheck monitor create ...` | Create a monitor (`--interval-minutes`, `--dry-run`) |
+| `supercheck monitor update <id> ...` | Update a monitor (`--interval-minutes`, `--dry-run`) |
 | `supercheck monitor delete <id>` | Delete a monitor |
 
-`supercheck test run` is local-only. `--cloud`, `--id`, and `--location` are deprecated for direct test execution.
+> **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.
+
+`supercheck test run` is local-only. Cloud test execution has been replaced by `supercheck job run` / `supercheck job trigger`.
 
 ### Variables, Tags & Notifications
 
@@ -170,7 +183,7 @@ supercheck upgrade
 |---|---|
 | `supercheck health` | Check API health |
 | `supercheck locations` | List available execution locations |
-| `supercheck doctor` | Validate local CLI dependencies and config |
+| `supercheck doctor` | Validate local CLI dependencies and config (`--fix`) |
 | `supercheck upgrade` | Upgrade the CLI to the latest release |
 
 ## Configuration
@@ -235,6 +248,11 @@ test:
 | `SUPERCHECK_TOKEN` | CLI token for authentication (CI/CD) |
 | `SUPERCHECK_TRIGGER_KEY` | Trigger key for `job trigger` |
 | `SUPERCHECK_URL` | Custom API URL (self-hosted) |
+| `SUPERCHECK_ORG` | Override organization ID from config |
+| `SUPERCHECK_PROJECT` | Override project ID from config |
+| `HTTPS_PROXY` | Proxy URL for HTTPS requests |
+| `HTTP_PROXY` | Proxy URL for HTTP requests |
+| `NO_PROXY` | Hosts to bypass proxy (comma-separated) |
 
 ## Global Options
 
@@ -243,10 +261,12 @@ test:
 | `--json` | Output in JSON format |
 | `--quiet` | Suppress non-essential output |
 | `--debug` | Enable debug logging |
+| `--config <path>` | Path to config file (for config-aware commands) |
 | `-v, --version` | Show CLI version |
 
 ## Links
 
 - [Website](https://supercheck.io)
-- [Documentation](https://supercheck.io/docs/app/welcome)
+- [CLI Documentation](https://supercheck.io/docs/cli/commands)
+- [App Documentation](https://supercheck.io/docs/app/welcome)
 - [GitHub](https://github.com/supercheck-io/supercheck)