@qualflare/cli 0.1.10 → 0.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,58 @@
1
+ # @qualflare/cli
2
+
3
+ npm distribution of the **Qualflare CLI** (`qf`) — upload test results to [Qualflare](https://qualflare.com) from any CI pipeline or local machine. Supports 23 testing frameworks with automatic format detection.
4
+
5
+ This package is a thin installer with **no runtime dependencies**: on `npm install` it downloads the platform-native `qf` binary for your OS/architecture from the matching [GitHub release](https://github.com/Qualflare/qualflare-cli/releases), verifies its SHA-256 checksum against the release `checksums.txt`, and exposes it as the `qf` command.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install -g @qualflare/cli
11
+ qf version
12
+ ```
13
+
14
+ Requires Node ≥ 16. Prebuilt binaries are provided for:
15
+
16
+ | OS | Architectures |
17
+ |----|---------------|
18
+ | macOS | arm64, x64 |
19
+ | Linux | arm64, x64 |
20
+ | Windows | arm64, x64 |
21
+
22
+ ## Quick start
23
+
24
+ ```bash
25
+ # Save your project API token (Project → Settings → Access Tokens in the dashboard)
26
+ qf login myapp qf_your_token_here
27
+
28
+ # Upload a report — the framework is auto-detected from the file
29
+ qf myapp collect path/to/results.xml
30
+ ```
31
+
32
+ ## In CI
33
+
34
+ ```bash
35
+ qf login ci "$QF_TOKEN" --force
36
+ qf ci collect test-results/*.xml
37
+ ```
38
+
39
+ Set `QF_TOKEN` from a secret, plus `QF_BRANCH` / `QF_COMMIT` for git context (auto-detected from common CI variables when unset).
40
+
41
+ ## Environment variables (install-time)
42
+
43
+ | Variable | Purpose |
44
+ |----------|---------|
45
+ | `QUALFLARE_CLI_SKIP_INSTALL=1` | Skip the postinstall binary download (e.g. restricted/offline installs) |
46
+ | `QUALFLARE_CLI_BASE_URL` | Override the release download base URL (mirrors / air-gapped setups) |
47
+
48
+ ## Other install methods
49
+
50
+ Homebrew, Docker (GHCR + Docker Hub), and direct binary downloads are documented in the [main README](https://github.com/Qualflare/qualflare-cli#installation).
51
+
52
+ ## Links
53
+
54
+ - **Documentation:** https://docs.qualflare.com
55
+ - **Source & issues:** https://github.com/Qualflare/qualflare-cli
56
+ - **Releases / changelog:** https://github.com/Qualflare/qualflare-cli/releases
57
+
58
+ Licensed under the [Apache License 2.0](https://github.com/Qualflare/qualflare-cli/blob/main/LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qualflare/cli",
3
- "version": "0.1.10",
3
+ "version": "0.1.11",
4
4
  "description": "Qualflare CLI (qf) — upload test results to Qualflare from any CI or local machine. Installs the platform-native binary from the matching GitHub release.",
5
5
  "keywords": [
6
6
  "qualflare",