@supercheck/cli 0.1.0-beta.1

package/README.md

@@ -0,0 +1,79 @@
+# @supercheck/cli
+
+Supercheck CLI — monitoring-as-code for Playwright and k6.
+
+## Installation
+
+```bash
+npm install -g @supercheck/cli
+```
+
+Or use with npx:
+
+```bash
+npx @supercheck/cli
+```
+
+## Quick Start
+
+```bash
+# Initialize a new project
+supercheck init
+
+# Authenticate
+supercheck login --token <your-token>
+
+# Validate config
+supercheck config validate
+
+# Check API health
+supercheck health
+```
+
+## Configuration
+
+Create a `supercheck.config.ts` in your project root:
+
+```typescript
+import { defineConfig } from '@supercheck/cli'
+
+export default defineConfig({
+  schemaVersion: '1.0',
+  project: {
+    organization: 'my-org',
+    project: 'my-project',
+  },
+  tests: {
+    playwright: {
+      testMatch: '_supercheck_/tests/**/*.pw.ts',
+      browser: 'chromium',
+    },
+    k6: {
+      testMatch: '_supercheck_/tests/**/*.k6.ts',
+    },
+  },
+})
+```
+
+## File Conventions
+
+```
+_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
+```
+
+## Development
+
+```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
+```