@trojeancedric/sentinel-cli 1.0.0

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

@@ -0,0 +1,310 @@
+# @trojeancedric/sentinel-cli
+
+Open-Source Testing, Monitoring, and Reliability — as Code.
+
+[![npm version](https://img.shields.io/npm/v/@trojeancedric/sentinel-cli.svg)](https://www.npmjs.com/package/@trojeancedric/sentinel-cli)
+[![License](https://img.shields.io/badge/license-Supercheck_Community_License-blue.svg)](LICENSE)
+
+The Sentinel 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, jobs, and status pages in TypeScript.
+- **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
+
+```bash
+npm install -g @trojeancedric/sentinel-cli
+```
+
+Or run directly with `npx`:
+
+```bash
+npx @trojeancedric/sentinel-cli --help
+```
+
+## Upgrade
+
+Upgrade the CLI to the latest release:
+
+```bash
+sentinel upgrade
+```
+
+## Migrating from `@supercheck/cli`
+
+The CLI was renamed from `supercheck` to `sentinel`. The old names still work but
+warn, so you can migrate at your own pace.
+
+```bash
+npm uninstall -g @supercheck/cli
+npm install -g @trojeancedric/sentinel-cli
+```
+
+| Was | Now | Old form still accepted? |
+|---|---|---|
+| `supercheck <cmd>` | `sentinel <cmd>` | ✗ — the old binary is gone |
+| `@supercheck/cli` | `@trojeancedric/sentinel-cli` | ✗ |
+| `supercheck.config.ts` | `sentinel.config.ts` | ✓ with a warning |
+| `supercheck.config.local.ts` | `sentinel.config.local.ts` | ✓ with a warning |
+| `SUPERCHECK_TOKEN`, `SUPERCHECK_TRIGGER_KEY`, `SUPERCHECK_URL`, `SUPERCHECK_ORG`, `SUPERCHECK_PROJECT` | `SENTINEL_*` | ✓ with a warning |
+| `_supercheck_/` test folder | `_sentinel_/` | ✓ — via explicit `testMatch` |
+| `SupercheckConfig`, `SupercheckUserConfig` | `SentinelConfig`, `SentinelUserConfig` | ✓ — deprecated type aliases |
+
+Unchanged on purpose: **token values keep their `sck_live_` / `sck_trigger_` /
+`sck_test_` prefixes** (the server issues them), as do API endpoints and the
+default API URL.
+
+Your stored login is migrated automatically the first time you run `sentinel` —
+no need to re-authenticate.
+
+`_supercheck_/` is only renamed for **new** projects. An existing project keeps
+working because its `testMatch` patterns point at the old folder; rename the
+folder and update `tests.playwright.testMatch` / `tests.k6.testMatch` together
+when you want to move.
+
+## Quick Start
+
+1. **Initialize a new project**:
+   ```bash
+   sentinel init
+   ```
+  This creates a `sentinel.config.ts` and a `_sentinel_` directory with example tests under `_sentinel_/playwright` and `_sentinel_/k6`.
+
+2. **Authenticate**:
+   ```bash
+   sentinel login --token sck_live_...
+   ```
+   You can generate a CLI token in your Dashboard under **Project Settings > CLI Tokens**.
+
+3. **Pull existing resources**:
+   ```bash
+   sentinel pull
+   ```
+
+4. **Preview & Deploy**:
+   ```bash
+   sentinel diff
+   sentinel deploy
+   ```
+
+5. **Validate scripts**:
+  ```bash
+  sentinel validate
+  ```
+  Validation runs automatically during deploy and cannot be skipped.
+
+6. **Run tests locally (optional)**:
+  ```bash
+  sentinel test run --file _sentinel_/playwright/homepage-check.<id>.pw.ts
+  sentinel test run --all --type browser
+  sentinel test run --all --type performance
+  sentinel test run --all --type api
+  sentinel test run --all --type database
+  sentinel test run --all --type custom
+  ```
+
+  For remote execution with persisted run history, trigger a job:
+  ```bash
+  sentinel job run --id <job-id>
+  # or (CI/CD trigger key flow)
+  SENTINEL_TRIGGER_KEY=sck_trigger_... sentinel job trigger <job-id>
+  ```
+
+  `sentinel job trigger` requires `SENTINEL_TRIGGER_KEY`. If you also pass `--wait`, set `SENTINEL_TOKEN` so the CLI can poll the resulting run.
+
+## Command Reference
+
+### Authentication
+
+| Command | Description |
+|---|---|
+| `sentinel login --token <token>` | Authenticate with a CLI token |
+| `sentinel logout` | Clear stored credentials |
+| `sentinel whoami` | Show current authentication context |
+
+### Monitoring-as-Code
+
+| Command | Description |
+|---|---|
+| `sentinel init` | Initialize a new project with config and example tests |
+| `sentinel pull` | Sync cloud resources to local config |
+| `sentinel diff` | Preview changes between local config and cloud |
+| `sentinel deploy` | Apply local config changes to the cloud |
+| `sentinel validate` | Validate local test scripts (same rules as Playground) |
+| `sentinel destroy` | Remove all managed resources from the cloud (`--dry-run`, `--force`) |
+| `sentinel config validate` | Validate your `sentinel.config.ts` |
+| `sentinel config print` | Print resolved `sentinel.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 (`sentinel login --token ...`).
+
+### Jobs & Runs
+
+| Command | Description |
+|---|---|
+| `sentinel job list` | List all jobs |
+| `sentinel job get <id>` | Get job details |
+| `sentinel job create --name <name> --tests <test-id...>` | Create a new job with tests (`--dry-run`) |
+| `sentinel job update <id> --name ...` | Update job fields (`--dry-run`) |
+| `sentinel job delete <id>` | Delete a job |
+| `sentinel job keys <jobId>` | List trigger keys for a job |
+| `sentinel job keys create <jobId> --name <name>` | Create a trigger key |
+| `sentinel job keys delete <jobId> <keyId>` | Revoke a trigger key |
+| `sentinel job run --id <job-id>` | Run a job immediately |
+| `sentinel job run --local` | Run a job locally using local test files |
+| `sentinel job trigger <id> --wait` | Trigger a job with a trigger key and wait for completion (CI/CD) |
+| `sentinel run list` | List recent execution runs (`--job`, `--status`, `--page`, `--limit`) |
+| `sentinel run get <id>` | Get run details |
+| `sentinel run status <id>` | Get run status |
+| `sentinel run permissions <id>` | Get run permissions |
+| `sentinel run stream <id>` | Stream live console output |
+| `sentinel run cancel <id>` | Cancel a running execution |
+
+### Tests & Monitors
+
+| Command | Description |
+|---|---|
+| `sentinel test list` | List all tests (`--search`, `--type`, `--page`, `--limit`) |
+| `sentinel test get <id>` | Get test details (`--include-script`) |
+| `sentinel test create` | Create a new test (`--dry-run`) |
+| `sentinel test update <id>` | Update a test (`--dry-run`) |
+| `sentinel test delete <id>` | Delete a test |
+| `sentinel test validate` | Validate local test scripts (same rules as Playground) |
+| `sentinel test run` | Run tests locally |
+| `sentinel test tags <id>` | List tags for a test |
+| `sentinel test status <id>` | Stream live status events for a test |
+| `sentinel monitor list` | List all monitors |
+| `sentinel monitor get <id>` | Get monitor details |
+| `sentinel monitor results <id>` | Get monitor check results |
+| `sentinel monitor stats <id>` | Get monitor statistics |
+| `sentinel monitor status <id>` | Get current monitor status |
+| `sentinel monitor create ...` | Create a monitor (`--interval-minutes`, `--dry-run`) |
+| `sentinel monitor update <id> ...` | Update a monitor (`--interval-minutes`, `--dry-run`) |
+| `sentinel monitor delete <id>` | Delete a monitor |
+
+> **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.
+
+`sentinel test run` is local-only. Cloud test execution has been replaced by `sentinel job run` / `sentinel job trigger`.
+
+### Variables, Tags & Notifications
+
+| Command | Description |
+|---|---|
+| `sentinel var list / get / set / delete` | Manage project variables (`var set` supports `--value-stdin` for secrets) |
+| `sentinel tag list / create / delete` | Manage tags |
+| `sentinel notification list / get / create / update / delete / test` | Manage notification providers |
+| `sentinel alert history` | View alert history |
+| `sentinel audit` | View audit logs (admin) |
+
+`sentinel notification test` validates an ad-hoc provider configuration before creation or update. It does not take an existing provider ID.
+
+```bash
+sentinel notification test --type slack --config '{"webhookUrl":"https://hooks.slack.com/..."}'
+```
+
+### Utilities
+
+| Command | Description |
+|---|---|
+| `sentinel health` | Check API health |
+| `sentinel locations` | List available execution locations |
+| `sentinel doctor` | Validate local CLI dependencies and config (`--fix`) |
+| `sentinel upgrade` | Upgrade the CLI to the latest release |
+
+## Configuration
+
+The `sentinel.config.ts` file is the source of truth for your project configuration.
+
+```typescript
+import { defineConfig } from '@trojeancedric/sentinel-cli'
+
+export default defineConfig({
+  schemaVersion: '1.0',
+  project: {
+    organization: 'my-org-id',
+    project: 'my-project-id',
+  },
+  tests: {
+    playwright: {
+      testMatch: '_sentinel_/playwright/**/*.pw.ts',
+    },
+    k6: {
+      testMatch: '_sentinel_/k6/**/*.k6.ts',
+    },
+  },
+  monitors: [
+    {
+      name: 'API Health',
+      type: 'http_request',
+      target: 'https://api.example.com/health',
+      frequencyMinutes: 5,
+    }
+  ]
+})
+```
+
+## CI/CD Integration
+
+### GitHub Actions
+
+```yaml
+- name: Run E2E Tests
+  run: npx @trojeancedric/sentinel-cli job trigger ${{ secrets.SENTINEL_JOB_ID }} --wait --json
+  env:
+    SENTINEL_TRIGGER_KEY: ${{ secrets.SENTINEL_TRIGGER_KEY }}
+    SENTINEL_TOKEN: ${{ secrets.SENTINEL_TOKEN }}
+```
+
+`SENTINEL_TRIGGER_KEY` is required to start the run. `SENTINEL_TOKEN` is only needed here because the example uses `--wait`.
+
+### GitLab CI
+
+```yaml
+test:
+  image: node:18
+  script:
+    - npm install -g @trojeancedric/sentinel-cli
+    - sentinel job trigger $SENTINEL_JOB_ID --wait
+  variables:
+    SENTINEL_TRIGGER_KEY: $SENTINEL_TRIGGER_KEY
+    SENTINEL_TOKEN: $SENTINEL_TOKEN
+```
+
+## Environment Variables
+
+| Variable | Description |
+|---|---|
+| `SENTINEL_TOKEN` | CLI token for authentication (CI/CD) |
+| `SENTINEL_TRIGGER_KEY` | Trigger key for `job trigger` |
+| `SENTINEL_URL` | Custom API URL (self-hosted) |
+| `SENTINEL_ORG` | Override organization ID from config |
+| `SENTINEL_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
+
+| Flag | Description |
+|---|---|
+| `--json` | Output in JSON format |
+| `--quiet` | Suppress non-essential output |
+| `--debug` | Enable debug logging |
+| `-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)
+- [CLI Documentation](https://supercheck.io/docs/cli/commands)
+- [App Documentation](https://supercheck.io/docs/app/welcome)
+- [GitHub](https://github.com/sentinel-io/sentinel)