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

package/README.md

@@ -9,10 +9,10 @@ The Supercheck CLI provides a first-class command-line interface for managing yo
 
 ## Features
 
-- **Monitoring-as-Code**: Define monitors, tests, and status pages in TypeScript.
+- **Monitoring-as-Code**: Define monitors, tests, jobs, 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.
+- **Full Resource Management**: Manage all resources (tests, monitors, jobs, variables, tags, notifications) from the terminal.
+- **Modern UX**: Spinners, colorized output, status indicators, and interactive prompts.
 
 ## Installation
 
@@ -40,13 +40,14 @@ npx @supercheck/cli --help
    ```
    You can generate a CLI token in your Dashboard under **Project Settings > CLI Tokens**.
 
-3. **Validate configuration**:
+3. **Pull existing resources**:
    ```bash
-   supercheck config validate
+   supercheck pull
    ```
 
-4. **Deploy to Cloud**:
+4. **Preview & Deploy**:
    ```bash
+   supercheck diff
    supercheck deploy
    ```
 
@@ -54,30 +55,60 @@ npx @supercheck/cli --help
 
 ### Authentication
 
-- `supercheck login --token <token>`: Authenticate with a CLI token.
-- `supercheck logout`: clear stored credentials.
-- `supercheck whoami`: Show current authentication context.
+| Command | Description |
+|---|---|
+| `supercheck login --token <token>` | Authenticate with a CLI token |
+| `supercheck logout` | Clear stored credentials |
+| `supercheck whoami` | Show current authentication context |
+
+### Monitoring-as-Code
+
+| Command | Description |
+|---|---|
+| `supercheck init` | Initialize a new project with config and example tests |
+| `supercheck pull` | Sync cloud resources to local config |
+| `supercheck diff` | Preview changes between local config and cloud |
+| `supercheck deploy` | Apply local config changes to the cloud |
+| `supercheck destroy --force` | Remove all managed resources from the cloud |
+| `supercheck config validate` | Validate your `supercheck.config.ts` |
 
 ### 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.
+| Command | Description |
+|---|---|
+| `supercheck job list` | List all jobs |
+| `supercheck job create` | Create a new job |
+| `supercheck job run` | Run a job immediately |
+| `supercheck job trigger <id> --wait` | Trigger a job and wait for completion (CI/CD) |
+| `supercheck run list` | List recent execution runs |
+| `supercheck run stream <id>` | Stream live console output |
 
 ### 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.
+| Command | Description |
+|---|---|
+| `supercheck test list` | List all tests |
+| `supercheck test create` | Create a new test |
+| `supercheck test validate` | Validate local test scripts |
+| `supercheck monitor list` | List all monitors |
+| `supercheck monitor status <id>` | Check real-time monitor status |
+
+### Variables, Tags & Notifications
 
-### Resources
+| Command | Description |
+|---|---|
+| `supercheck var list / get / set / delete` | Manage project variables |
+| `supercheck tag list / create / delete` | Manage tags |
+| `supercheck notification list / delete` | Manage notification providers |
+| `supercheck alert history` | View alert history |
+| `supercheck audit` | View audit logs (admin) |
 
-- `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.
+### Utilities
+
+| Command | Description |
+|---|---|
+| `supercheck health` | Check API health |
+| `supercheck locations` | List available execution locations |
 
 ## Configuration
 
@@ -89,8 +120,8 @@ import { defineConfig } from '@supercheck/cli'
 export default defineConfig({
   schemaVersion: '1.0',
   project: {
-    organization: 'my-org-slug',
-    project: 'my-project-slug',
+    organization: 'my-org-id',
+    project: 'my-project-id',
   },
   tests: {
     playwright: {
@@ -117,8 +148,7 @@ export default defineConfig({
 
 ```yaml
 - name: Run E2E Tests
-  run: |
-    npx @supercheck/cli job trigger ${{ secrets.SUPERCHECK_JOB_ID }} --wait --json
+  run: npx @supercheck/cli job trigger ${{ secrets.SUPERCHECK_JOB_ID }} --wait --json
   env:
     SUPERCHECK_TOKEN: ${{ secrets.SUPERCHECK_TOKEN }}
 ```
@@ -135,3 +165,25 @@ test:
     SUPERCHECK_TOKEN: $SUPERCHECK_TOKEN
 ```
 
+## Environment Variables
+
+| Variable | Description |
+|---|---|
+| `SUPERCHECK_TOKEN` | CLI token for authentication (CI/CD) |
+| `SUPERCHECK_TRIGGER_KEY` | Trigger key for `job trigger` |
+| `SUPERCHECK_URL` | Custom API URL (self-hosted) |
+
+## Global Options
+
+| Flag | Description |
+|---|---|
+| `--json` | Output in JSON format |
+| `--quiet` | Suppress non-essential output |
+| `--debug` | Enable debug logging |
+| `-v, --version` | Show CLI version |
+
+## Links
+
+- [Website](https://supercheck.io)
+- [Documentation](https://docs.supercheck.io)
+- [GitHub](https://github.com/supercheck-io/supercheck)