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

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.2" : "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";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supercheck/cli",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.3",
   "description": "Open-Source Testing, Monitoring, and Reliability — as Code",
   "keywords": [
     "monitoring",
@@ -22,7 +22,7 @@
   },
   "author": "Supercheck <hello@supercheck.io>",
   "type": "module",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Supercheck Community License",
   "publishConfig": {
     "access": "public"
   },