@supercheck/cli 0.1.0-beta.1 → 0.1.0-beta.3

package/LICENSE

@@ -0,0 +1,62 @@
+Supercheck Community License
+
+Copyright (c) 2026 Supercheck Contributors
+
+GRANT OF RIGHTS
+
+You are granted a non-exclusive, royalty-free license to use, modify, and distribute
+this software and its source code, subject to the restrictions and conditions outlined below.
+
+PERMITTED USE
+
+1. Personal Use: You may use Supercheck for personal projects and development purposes.
+
+2. Open Source Development: You may use Supercheck as a foundation for open-source projects
+   that advance the testing and monitoring community, provided such projects are also
+   made publicly available under compatible open-source terms.
+
+3. Internal Deployment: You may deploy and operate Supercheck internally within your
+   organization for your own business operations and testing needs.
+
+4. Contributing Back: You may submit improvements, bug fixes, and features back to the
+   official Supercheck project via pull requests.
+
+RESTRICTIONS
+
+You may NOT:
+
+1. Whitelabel or resell Supercheck as your own product or service.
+
+2. Launch a competitive SaaS (Software-as-a-Service) product, testing platform, or
+   monitoring service based on or derived from Supercheck without explicit written
+   permission from Supercheck Contributors.
+
+3. Use Supercheck as the primary component in a commercial offering that competes
+   with the official Supercheck service.
+
+4. Remove or obscure copyright notices, licenses, or attribution.
+
+5. Use Supercheck's branding, trademarks, or logos in any way that implies endorsement
+   or affiliation without permission.
+
+COMMERCIAL LICENSING
+
+If you wish to use Supercheck for commercial purposes, competitive products, or
+whitelabeling, please contact the Supercheck team to discuss a commercial license agreement.
+
+DISCLAIMER
+
+This software is provided "AS IS" without warranty of any kind, express or implied,
+including but not limited to the warranties of merchantability, fitness for a particular
+purpose, and non-infringement. In no event shall the authors or copyright holders be
+liable for any claim, damages, or other liability arising from the use of this software.
+
+TERMINATION
+
+Violation of the restrictions above will result in immediate termination of your license
+and rights granted hereunder. You must cease all use and distribution of Supercheck.
+
+GOVERNING LAW
+
+This license is governed by applicable law. Any disputes shall be resolved in the
+appropriate courts of jurisdiction.

package/README.md

@@ -1,6 +1,18 @@
 # @supercheck/cli
 
-Supercheck CLI — monitoring-as-code for Playwright and k6.
+Open-Source Testing, Monitoring, and Reliability — as Code.
+
+[![npm version](https://img.shields.io/npm/v/@supercheck/cli.svg)](https://www.npmjs.com/package/@supercheck/cli)
+[![License](https://img.shields.io/badge/license-Supercheck_Community_License-blue.svg)](LICENSE)
+
+The Supercheck CLI provides a first-class command-line interface for managing your testing and monitoring infrastructure as code. It is designed for CI/CD integration, automation, and power-user workflows.
+
+## Features
+
+- **Monitoring-as-Code**: Define monitors, tests, and status pages in TypeScript.
+- **CI/CD Integration**: Trigger jobs and wait for results directly from your pipeline.
+- **Local Development**: Run and debug tests locally before deploying.
+- **Full API Access**: Manage all resources (jobs, variables, tags) from the terminal.
 
 ## Installation
 
@@ -8,31 +20,68 @@ Supercheck CLI — monitoring-as-code for Playwright and k6.
 npm install -g @supercheck/cli
 ```
 
-Or use with npx:
+Or run directly with `npx`:
 
 ```bash
-npx @supercheck/cli
+npx @supercheck/cli --help
 ```
 
 ## Quick Start
 
-```bash
-# Initialize a new project
-supercheck init
+1. **Initialize a new project**:
+   ```bash
+   supercheck init
+   ```
+   This creates a `supercheck.config.ts` and a `_supercheck_` directory with example tests.
 
-# Authenticate
-supercheck login --token <your-token>
+2. **Authenticate**:
+   ```bash
+   supercheck login --token sck_live_...
+   ```
+   You can generate a CLI token in your Dashboard under **Project Settings > CLI Tokens**.
 
-# Validate config
-supercheck config validate
+3. **Validate configuration**:
+   ```bash
+   supercheck config validate
+   ```
 
-# Check API health
-supercheck health
-```
+4. **Deploy to Cloud**:
+   ```bash
+   supercheck deploy
+   ```
+
+## Command Reference
+
+### Authentication
+
+- `supercheck login --token <token>`: Authenticate with a CLI token.
+- `supercheck logout`: clear stored credentials.
+- `supercheck whoami`: Show current authentication context.
+
+### Jobs & Runs
+
+- `supercheck job list`: List all jobs.
+- `supercheck job trigger <id> --wait`: Trigger a job and wait for completion (ideal for CI/CD).
+- `supercheck job run --id <id>`: Run a job immediately.
+- `supercheck run list`: List recent execution runs.
+- `supercheck run stream <id>`: Stream live console output from a running job.
+
+### Tests & Monitors
+
+- `supercheck test list`: List all tests.
+- `supercheck test create --file <path>`: Create a new test from a script file.
+- `supercheck monitor list`: List all monitors.
+- `supercheck monitor status <id>`: Check the real-time status of a monitor.
+
+### Resources
+
+- `supercheck pull`: Sync cloud resources to your local config.
+- `supercheck diff`: Preview changes between local config and cloud.
+- `supercheck deploy`: Apply local config changes to the cloud.
 
 ## Configuration
 
-Create a `supercheck.config.ts` in your project root:
+The `supercheck.config.ts` file is the source of truth for your project configuration.
 
 ```typescript
 import { defineConfig } from '@supercheck/cli'
@@ -40,40 +89,49 @@ import { defineConfig } from '@supercheck/cli'
 export default defineConfig({
   schemaVersion: '1.0',
   project: {
-    organization: 'my-org',
-    project: 'my-project',
+    organization: 'my-org-slug',
+    project: 'my-project-slug',
   },
   tests: {
     playwright: {
       testMatch: '_supercheck_/tests/**/*.pw.ts',
-      browser: 'chromium',
     },
     k6: {
       testMatch: '_supercheck_/tests/**/*.k6.ts',
     },
   },
+  monitors: [
+    {
+      name: 'API Health',
+      type: 'http_request',
+      target: 'https://api.example.com/health',
+      frequencyMinutes: 5,
+    }
+  ]
 })
 ```
 
-## File Conventions
+## CI/CD Integration
 
-```
-_supercheck_/
-├── tests/
-│   ├── homepage.pw.ts       # Playwright test
-│   └── load-test.k6.ts      # k6 test
-├── monitors/
-│   └── api-monitor.ts       # Monitor definition
-└── status-pages/
-    └── main-status.ts       # Status page definition
+### GitHub Actions
+
+```yaml
+- name: Run E2E Tests
+  run: |
+    npx @supercheck/cli job trigger ${{ secrets.SUPERCHECK_JOB_ID }} --wait --json
+  env:
+    SUPERCHECK_TOKEN: ${{ secrets.SUPERCHECK_TOKEN }}
 ```
 
-## Development
+### GitLab CI
 
-```bash
-npm install
-npm run dev        # Watch mode
-npm run build      # Production build
-npm run typecheck  # Type checking
-npm run supercheck # Run CLI in dev mode
+```yaml
+test:
+  image: node:18
+  script:
+    - npm install -g @supercheck/cli
+    - supercheck job trigger $SUPERCHECK_JOB_ID --wait
+  variables:
+    SUPERCHECK_TOKEN: $SUPERCHECK_TOKEN
 ```
+

package/dist/bin/supercheck.js

@@ -210,7 +210,7 @@ function requireTriggerKey() {
 }
 
 // src/version.ts
-var CLI_VERSION = true ? "0.1.0-beta.1" : "0.0.0-dev";
+var CLI_VERSION = true ? "0.1.0-beta.3" : "0.0.0-dev";
 
 // src/api/client.ts
 import { ProxyAgent } from "undici";
@@ -1713,7 +1713,7 @@ jobCommand.command("get <id>").description("Get job details").action(async (id)
   const { data } = await client.get(`/api/jobs/${id}`);
   outputDetail(data);
 });
-jobCommand.command("create").description("Create a new job").requiredOption("--name <name>", "Job name").option("--description <description>", "Job description", "").option("--schedule <cron>", "Cron schedule expression").option("--timeout <seconds>", "Timeout in seconds", "300").option("--retries <count>", "Retry count on failure", "0").action(async (options) => {
+jobCommand.command("create").description("Create a new job").requiredOption("--name <name>", "Job name").option("--description <description>", "Job description", "").option("--type <type>", "Job type (playwright, k6)").option("--schedule <cron>", "Cron schedule expression").option("--timeout <seconds>", "Timeout in seconds", "300").option("--retries <count>", "Retry count on failure", "0").action(async (options) => {
   const client = createAuthenticatedClient();
   const body = {
     name: options.name,
@@ -1723,6 +1723,7 @@ jobCommand.command("create").description("Create a new job").requiredOption("--n
     config: {},
     tests: []
   };
+  if (options.type) body.jobType = options.type;
   if (options.schedule) body.cronSchedule = options.schedule;
   const { data } = await client.post("/api/jobs", body);
   logger.success(`Job "${options.name}" created (${data.id})`);
@@ -2379,11 +2380,7 @@ monitorCommand.command("status <id>").description("Get current monitor status").
 });
 monitorCommand.command("create").description("Create a new monitor").requiredOption("--name <name>", "Monitor name").requiredOption("--url <url>", "URL to monitor").option("--type <type>", "Monitor type (http_request, website, ping_host, port_check, synthetic_test)", "http_request").option("--interval <seconds>", "Check interval in seconds", "300").option("--timeout <seconds>", "Request timeout in seconds", "30").option("--method <method>", "HTTP method (GET, POST, HEAD)", "GET").action(async (options) => {
   const client = createAuthenticatedClient();
-  const intervalSeconds = parseInt(options.interval, 10);
-  if (!Number.isFinite(intervalSeconds) || intervalSeconds <= 0) {
-    logger.error("Invalid --interval value: must be a positive number of seconds");
-    return;
-  }
+  const intervalSeconds = parseIntStrict(options.interval, "--interval", { min: 1 });
   const frequencyMinutes = Math.max(1, Math.ceil(intervalSeconds / 60));
   const body = {
     name: options.name,
@@ -2391,7 +2388,7 @@ monitorCommand.command("create").description("Create a new monitor").requiredOpt
     type: options.type,
     frequencyMinutes,
     config: {
-      timeout: parseInt(options.timeout, 10) * 1e3,
+      timeout: parseIntStrict(options.timeout, "--timeout", { min: 1 }) * 1e3,
       // API expects milliseconds
       method: options.method
     }
@@ -2406,16 +2403,12 @@ monitorCommand.command("update <id>").description("Update a monitor").option("--
   if (options.name !== void 0) body.name = options.name;
   if (options.url !== void 0) body.target = options.url;
   if (options.interval !== void 0) {
-    const intervalSeconds = parseInt(options.interval, 10);
-    if (!Number.isFinite(intervalSeconds) || intervalSeconds <= 0) {
-      logger.error("Invalid --interval value: must be a positive number of seconds");
-      return;
-    }
+    const intervalSeconds = parseIntStrict(options.interval, "--interval", { min: 1 });
     body.frequencyMinutes = Math.max(1, Math.ceil(intervalSeconds / 60));
   }
   if (options.active !== void 0) body.enabled = options.active === "true";
   const config = {};
-  if (options.timeout !== void 0) config.timeout = parseInt(options.timeout, 10) * 1e3;
+  if (options.timeout !== void 0) config.timeout = parseIntStrict(options.timeout, "--timeout", { min: 1 }) * 1e3;
   if (options.method !== void 0) config.method = options.method;
   if (Object.keys(config).length > 0) body.config = config;
   if (Object.keys(body).length === 0) {