flakiness 0.156.0 → 0.157.0

package/README.md

@@ -1,30 +1,129 @@
-# Flakiness SDK
-
-The package consists of:
-- A CLI to interact with flakiness.io service
-- A set of reporters for popular test runners to generate & upload Flakiness
-  report.
-
-## Getting Started
-
-To start using reporter with Playwright Test:
-
-1. Install this package:
-    ```bash
-    npm i @flakiness/sdk@latest
-    ```
-2. Add flakiness.io  to the `playwright.config.ts` file:
-    ```ts
-    import { defineConfig } from '@playwright/test';
-
-    export default defineConfig({
-      reporter: [
-        ['list'],
-        ['@flakiness/sdk/playwright-test', {
-          endpoint: 'https://flakiness.io', // custom endpoint
-          token: '...', // Flakiness access token
-          collectBrowserVersion: true, // collect browser versions
-        }]
-      ],
-    });
-    ```
+# Flakiness CLI
+
+A command-line interface for interacting with [flakiness.io](https://flakiness.io) service.
+
+## Installation
+
+```bash
+npm install -g flakiness
+```
+
+Or run directly with npx:
+
+```bash
+npx flakiness <command>
+```
+
+## Commands
+
+### Authentication
+
+```bash
+# Login to flakiness.io (opens browser for authentication)
+flakiness login
+
+# Show current logged-in user
+flakiness whoami
+
+# Logout from current session
+flakiness logout
+```
+
+### Project Linking
+
+Link your local repository to a flakiness.io project to show local reports in context of their cloud history.
+
+```bash
+# Link using project URL
+flakiness link https://flakiness.io/my-org/my-project
+
+# Or using shorthand
+flakiness link flakiness.io/my-org/my-project
+
+# Check link status
+flakiness status
+
+# Unlink repository
+flakiness unlink
+```
+
+### Upload Reports
+
+Upload Flakiness report files to the service:
+
+```bash
+# Upload using linked project
+flakiness upload ./flakiness-report/report.json
+
+# Upload with explicit access token
+flakiness upload ./report.json --access-token <token>
+
+# Upload with custom endpoint
+flakiness upload ./report.json --endpoint https://custom.flakiness.io
+```
+
+**Options:**
+- `-t, --access-token <token>` — Read-write access token (env: `FLAKINESS_ACCESS_TOKEN`)
+- `-e, --endpoint <url>` — Service endpoint (env: `FLAKINESS_ENDPOINT`)
+- `--attachments-dir <dir>` — Directory containing attachments (defaults to report directory)
+
+### Download Reports
+
+Download reports from a linked project:
+
+```bash
+# Download all reports since a date
+flakiness download --since 2024-01-01
+
+# Download a specific run
+flakiness download --run-id 123
+
+# Download with parallel jobs
+flakiness download --since 2024-01-01 -j 4
+```
+
+### View Reports
+
+Open a local Flakiness report in the browser:
+
+```bash
+# Show report from default directory (flakiness-report)
+flakiness show
+
+# Show report from specific path
+flakiness show ./path/to/report
+```
+
+### Convert JUnit XML
+
+Convert JUnit XML reports to Flakiness format:
+
+```bash
+# Convert a single XML file
+flakiness convert-junit ./junit-report.xml
+
+# Convert all XML files in a directory
+flakiness convert-junit ./test-results/
+
+# With options
+flakiness convert-junit ./junit.xml \
+  --env-name "CI" \
+  --commit-id abc123 \
+  --output-dir ./flakiness-report
+```
+
+**Options:**
+- `--env-name <name>` — Environment name for the report (default: `junit`)
+- `--commit-id <id>` — Git commit ID (auto-detected if not provided)
+- `--output-dir <dir>` — Output directory (default: `flakiness-report`)
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `FLAKINESS_ACCESS_TOKEN` | Read-write access token for authentication |
+| `FLAKINESS_ENDPOINT` | Custom service endpoint URL |
+
+## License
+
+Fair Source 100

package/lib/cli/cli.js

@@ -3,7 +3,7 @@
 // src/cli/cli.ts
 import { FlakinessProjectConfig as FlakinessProjectConfig4, showReport } from "@flakiness/sdk";
 
-// ../node_modules/vlq/src/index.js
+// ../node_modules/.pnpm/vlq@2.0.4/node_modules/vlq/src/index.js
 var char_to_integer = {};
 var integer_to_char = {};
 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=".split("").forEach(function(char, i) {
@@ -971,16 +971,16 @@ import path7 from "path";
 // ../package.json
 var package_default = {
   name: "flakiness",
-  version: "0.156.0",
+  version: "0.157.0",
   type: "module",
   private: true,
   scripts: {
     minor: "./version.mjs minor",
     patch: "./version.mjs patch",
-    dev: "npx kubik --env-file=.env.dev -w $(find . -name build.mts) ./app.mts ./stripe.mts",
-    "dev+billing": "npx kubik --env-file=.env.dev+billing -w $(find . -name build.mts) ./app.mts ./stripe.mts",
-    prod: "npx kubik --env-file=.env.prodlocal -w ./cli/build.mts ./server.mts ./web/build.mts ./experimental/build.mts ./landing/build.mts",
-    build: "npx kubik $(find . -name build.mts)",
+    dev: "pnpm kubik --env-file=.env.dev -w $(find . -name build.mts) ./app.mts ./stripe.mts",
+    "dev+billing": "pnpm kubik --env-file=.env.dev+billing -w $(find . -name build.mts) ./app.mts ./stripe.mts",
+    prod: "pnpm kubik --env-file=.env.prodlocal -w ./cli/build.mts ./server.mts ./web/build.mts ./experimental/build.mts ./landing/build.mts",
+    build: "pnpm kubik $(find . -name build.mts)",
     perf: "node --max-old-space-size=10240 --enable-source-maps --env-file=.env.prodlocal experimental/lib/perf_filter.js"
   },
   engines: {
@@ -988,27 +988,15 @@ var package_default = {
   },
   author: "Degu Labs, Inc",
   license: "Fair Source 100",
-  workspaces: [
-    "./cli",
-    "./docs",
-    "./landing",
-    "./legal",
-    "./devenv",
-    "./database",
-    "./server",
-    "./shared",
-    "./experimental",
-    "./web"
-  ],
   devDependencies: {
     "@flakiness/playwright": "^0.154.0",
     "@playwright/test": "^1.57.0",
-    "@types/node": "^22.10.2",
-    esbuild: "^0.27.0",
-    glob: "^10.3.10",
+    "@types/node": "^22.19.3",
+    esbuild: "^0.27.2",
+    glob: "^10.5.0",
     kubik: "^0.24.0",
-    tsx: "^4.19.2",
-    typescript: "^5.6.2"
+    tsx: "^4.21.0",
+    typescript: "^5.9.3"
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flakiness",
-  "version": "0.156.0",
+  "version": "0.157.0",
   "private": false,
   "bin": {
     "flakiness": "./lib/cli/cli.js"
@@ -15,21 +15,14 @@
   "type": "module",
   "description": "",
   "types": "./types/index.d.ts",
-  "scripts": {
-    "build:all": "npm run build:win && npm run build:linux && npm run build:mac && npm run build:alpine && npm run build:mac_intel",
-    "build:win": "bun build ./lib/cli/cli.js --compile --minify --target=bun-windows-x64 --outfile dist/flakiness-win-x64.exe",
-    "build:linux": "bun build ./lib/cli/cli.js --compile --minify --target=bun-linux-x64 --outfile dist/flakiness-linux-x64",
-    "build:alpine": "bun build ./lib/cli/cli.js --compile --minify --target=bun-linux-x64-musl --outfile dist/flakiness-linux-x64-alpine",
-    "build:mac": "bun build ./lib/cli/cli.js --compile --minify --target=bun-darwin-arm64 --outfile dist/flakiness-macos-arm64",
-    "build:mac_intel": "bun build ./lib/cli/cli.js --compile --minify --target=bun-darwin-x64 --outfile dist/flakiness-macos-x64"
-  },
   "keywords": [],
   "author": "Degu Labs, Inc",
   "license": "Fair Source 100",
   "devDependencies": {
-    "@flakiness/server": "0.156.0",
-    "@flakiness/shared": "0.156.0",
-    "@playwright/test": "^1.57.0"
+    "@playwright/test": "^1.57.0",
+    "@types/express": "^4.17.20",
+    "@flakiness/server": "0.157.0",
+    "@flakiness/shared": "0.157.0"
   },
   "dependencies": {
     "@flakiness/sdk": "^0.154.0",
@@ -39,5 +32,13 @@
     "debug": "^4.3.7",
     "open": "^10.2.0",
     "ora": "^8.2.0"
+  },
+  "scripts": {
+    "build:all": "pnpm build:win && pnpm build:linux && pnpm build:mac && pnpm build:alpine && pnpm build:mac_intel",
+    "build:win": "bun build ./lib/cli/cli.js --compile --minify --target=bun-windows-x64 --outfile dist/flakiness-win-x64.exe",
+    "build:linux": "bun build ./lib/cli/cli.js --compile --minify --target=bun-linux-x64 --outfile dist/flakiness-linux-x64",
+    "build:alpine": "bun build ./lib/cli/cli.js --compile --minify --target=bun-linux-x64-musl --outfile dist/flakiness-linux-x64-alpine",
+    "build:mac": "bun build ./lib/cli/cli.js --compile --minify --target=bun-darwin-arm64 --outfile dist/flakiness-macos-arm64",
+    "build:mac_intel": "bun build ./lib/cli/cli.js --compile --minify --target=bun-darwin-x64 --outfile dist/flakiness-macos-x64"
   }
-}
+}