@supercheck/cli 0.1.1-rc.3 → 0.1.2

package/README.md

@@ -81,9 +81,11 @@ supercheck upgrade
   ```bash
   supercheck job run --id <job-id>
   # or (CI/CD trigger key flow)
-  supercheck job trigger <job-id> --wait
+  SUPERCHECK_TRIGGER_KEY=sck_trigger_... supercheck job trigger <job-id>
   ```
 
+  `supercheck job trigger` requires `SUPERCHECK_TRIGGER_KEY`. If you also pass `--wait`, set `SUPERCHECK_TOKEN` so the CLI can poll the resulting run.
+
 ## Command Reference
 
 ### Authentication
@@ -108,6 +110,9 @@ supercheck upgrade
 | `supercheck config print` | Print resolved `supercheck.config.ts` |
 
 > Note: In the current API, status pages are readable/deletable from CLI sync flows, but create/update endpoints are not available.
+> Pull preserves non-default status page language values (for example `es`, `fr`) for config visibility.
+
+> Note: Self-hosted email/password sign-in is for dashboard access. CLI authentication remains token-based (`supercheck login --token ...`).
 
 ### Jobs & Runs
 
@@ -123,7 +128,7 @@ supercheck upgrade
 | `supercheck job keys delete <jobId> <keyId>` | Revoke a trigger key |
 | `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 job trigger <id> --wait` | Trigger a job with a trigger key and wait for completion (CI/CD) |
 | `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 |
@@ -161,7 +166,7 @@ supercheck upgrade
 
 | Command | Description |
 |---|---|
-| `supercheck var list / get / set / delete` | Manage project variables |
+| `supercheck var list / get / set / delete` | Manage project variables (`var set` supports `--value-stdin` for secrets) |
 | `supercheck tag list / create / delete` | Manage tags |
 | `supercheck notification list / get / create / update / delete / test` | Manage notification providers |
 | `supercheck alert history` | View alert history |
@@ -216,9 +221,12 @@ export default defineConfig({
 - name: Run E2E Tests
   run: npx @supercheck/cli job trigger ${{ secrets.SUPERCHECK_JOB_ID }} --wait --json
   env:
+    SUPERCHECK_TRIGGER_KEY: ${{ secrets.SUPERCHECK_TRIGGER_KEY }}
     SUPERCHECK_TOKEN: ${{ secrets.SUPERCHECK_TOKEN }}
 ```
 
+`SUPERCHECK_TRIGGER_KEY` is required to start the run. `SUPERCHECK_TOKEN` is only needed here because the example uses `--wait`.
+
 ### GitLab CI
 
 ```yaml
@@ -228,6 +236,7 @@ test:
     - npm install -g @supercheck/cli
     - supercheck job trigger $SUPERCHECK_JOB_ID --wait
   variables:
+    SUPERCHECK_TRIGGER_KEY: $SUPERCHECK_TRIGGER_KEY
     SUPERCHECK_TOKEN: $SUPERCHECK_TOKEN
 ```
 
@@ -251,9 +260,10 @@ 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 |
 
+Config-aware commands such as `config`, `diff`, `deploy`, `pull`, `validate`, and `destroy` accept `--config <path>`.
+
 ## Links
 
 - [Website](https://supercheck.io)