@qawolf/cli 1.4.2 → 1.6.0

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 (4) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +2099 -1486
  3. package/package.json +3 -3
  4. package/skills/qawolf-cli/SKILL.md +36 -35
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qawolf/cli",
3
- "version": "1.4.2",
3
+ "version": "1.6.0",
4
4
  "description": "Run and manage QA Wolf flows from the terminal, CI, or an AI agent",
5
5
  "keywords": [
6
6
  "automation",
@@ -47,7 +47,7 @@
47
47
  "knip": "knip",
48
48
  "lint": "oxlint",
49
49
  "lint:fix": "oxlint --fix",
50
- "postbuild": "./scripts/postbuild.sh",
50
+ "postbuild": "bun scripts/postbuild.ts",
51
51
  "prepare": "git config core.hooksPath .githooks || true",
52
52
  "test": "bun run generate && bun test",
53
53
  "test:watch": "bun test --watch",
@@ -61,7 +61,7 @@
61
61
  "@napi-rs/keyring": "1.3.0",
62
62
  "@oxc-node/core": "0.1.0",
63
63
  "@playwright/test": "1.60.0",
64
- "@qawolf/api-contracts": "0.11.0",
64
+ "@qawolf/api-contracts": "0.20.0",
65
65
  "@qawolf/emails": "1.1.1",
66
66
  "@qawolf/flow-targets": "1.0.0",
67
67
  "@qawolf/flows": "0.1.4",
package/skills/qawolf-cli/SKILL.md CHANGED
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: qawolf-cli
3
- description: Run QA Wolf flows and trigger runs through the QA Wolf public API using the qawolf CLI. Use when asked to run, list, pull, or create QA Wolf tests/runs from a shell.
3
+ description: Manage QA Wolf through the qawolf CLI. Use when asked which QA Wolf environment variables are available or to list, set, or delete them; manage environments, flows, runs, tags, or issues; authenticate; install; or perform other QA Wolf operations from a shell.
4
4
  ---
5
5
 
6
6
  # QA Wolf CLI
@@ -24,6 +24,11 @@ target another deployment host, for example
24
24
  `https://app.staging.example.com`. `QAWOLF_API_URL` is a separate API endpoint
25
25
  and does not select the deployment host used by CLI commands.
26
26
 
27
+ For tasks that need the current environment, use `QAWOLF_ENVIRONMENT_ID`. If it
28
+ is unset, select an id from `qawolf --json environment find` and export it.
29
+ Check the command's help for its environment flag: variable commands use
30
+ `--environment-id`; `qawolf flows run` uses `--env`.
31
+
27
32
  ## Output
28
33
 
29
34
  When consuming output programmatically, always pass `--json` (or `--agent`).
@@ -40,31 +45,36 @@ write on timeout: it may have reached the server the first time.
40
45
 
41
46
  <!-- commands-table:start — generated by `bun run generate`, do not edit -->
42
47
 
43
- | Command | Kind | What it does |
44
- | -------------------------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
45
- | `qawolf auth login` | local | Authenticate with your QA Wolf API key |
46
- | `qawolf auth logout` | local | Remove stored credentials |
47
- | `qawolf auth whoami` | read | Show authentication status |
48
- | `qawolf automate` | write | Request an automation that builds the selected draft flows in an environment. |
49
- | `qawolf doctor` | local | Diagnose problems running flows locally |
50
- | `qawolf environment create` | write | Create an environment on the caller's team and return it in the environment.get shape. |
51
- | `qawolf environment get` | read | Read a single environment's name, kind, health status, and termination state. |
52
- | `qawolf environment listVariableNames` | read | List the names of an environment's variables, sorted. Names only — values never leave the server. |
53
- | `qawolf flows list` | local (read with --remote) | List flows matching [pattern] from the local project, or from a QA Wolf environment with --remote |
54
- | `qawolf flows pull` | read | Download an environment's flows into the local .qawolf/<env>/ cache |
55
- | `qawolf flows run` | local (read with --env) | Run flows matching [pattern], or every flow when omitted; with --env, pull missing flows from that QA Wolf environment |
56
- | `qawolf init` | local | Scaffold a QA Wolf project in the current directory |
57
- | `qawolf install` | local | Install every runtime dependency the project's flows need |
58
- | `qawolf install android` | local | Install Android system images, AVDs, and the Appium driver used by the project's Android flows |
59
- | `qawolf install browsers` | local | Install Playwright browsers used by the project's web flows |
60
- | `qawolf install clear` | local | Remove the managed runtime cache (all installed runtime versions) |
61
- | `qawolf issue create` | write | Create a bug or coverage request issue for the caller's team. Maintenance issues cannot be created through the public API. |
62
- | `qawolf issue find` | read | List the team's bug reports, maintenance reports, or coverage requests, newest first. |
63
- | `qawolf issue get` | read | Get an issue by id. |
64
- | `qawolf run create` | write | Create a run for the selected flows and/or tags in an environment. |
65
- | `qawolf run find` | read | List an environment's recent runs, newest first. |
66
- | `qawolf run get` | read | Get a run's status, per-flow results, and links. |
67
- | `qawolf tag create` | write | Create a tag on the caller's team. Tags select flows in run.create. |
48
+ | Command | Kind | What it does |
49
+ | -------------------------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50
+ | `qawolf auth login` | local | Authenticate with your QA Wolf API key |
51
+ | `qawolf auth logout` | local | Remove stored credentials |
52
+ | `qawolf auth whoami` | read | Show authentication status |
53
+ | `qawolf automate` | write | Request an automation that builds the selected draft flows in an environment. |
54
+ | `qawolf doctor` | local | Diagnose problems running flows locally |
55
+ | `qawolf environment create` | write | Create an environment on the caller's team and return it in the environment.get shape. |
56
+ | `qawolf environment deleteVariable` | write | Remove one environment variable by name. Succeeds whether or not the variable existed. |
57
+ | `qawolf environment find` | read | List the team's environments, newest first. |
58
+ | `qawolf environment get` | read | Read a single environment's name, kind, health status, and termination state. |
59
+ | `qawolf environment listVariableNames` | read | Use this to answer which QA Wolf environment variables are available to test code. Returns names only; values never leave the server. |
60
+ | `qawolf environment setVariable` | write | Create or replace an environment variable. If the user asks to create one for "my email" without naming it, use DEFAULT_ENVIRONMENT_EMAIL. The value is never returned. |
61
+ | `qawolf flow addTag` | write | Assign an existing tag to the selected flows. Create tags with tag.create. |
62
+ | `qawolf flows list` | local (read with --remote) | List flows matching [pattern] from the local project, or from a QA Wolf environment with --remote |
63
+ | `qawolf flows pull` | read | Download an environment's flows into the local .qawolf/<env>/ cache |
64
+ | `qawolf flows run` | local (read with --env) | Run flows matching [pattern], or every flow when omitted; with --env, pull missing flows from that QA Wolf environment |
65
+ | `qawolf init` | local | Scaffold a QA Wolf project in the current directory |
66
+ | `qawolf install` | local | Install every runtime dependency the project's flows need |
67
+ | `qawolf install android` | local | Install Android system images, AVDs, and the Appium driver used by the project's Android flows |
68
+ | `qawolf install browsers` | local | Install Playwright browsers used by the project's web flows |
69
+ | `qawolf install clear` | local | Remove the managed runtime cache (all installed runtime versions) |
70
+ | `qawolf issue create` | write | Create a bug or coverage request issue for the caller's team. Maintenance issues cannot be created through the public API. |
71
+ | `qawolf issue find` | read | List the team's bug reports, maintenance reports, or coverage requests, newest first. |
72
+ | `qawolf issue get` | read | Get an issue by id. |
73
+ | `qawolf run create` | write | Create a run for the selected flows and/or tags in an environment. |
74
+ | `qawolf run find` | read | List an environment's recent runs, newest first. |
75
+ | `qawolf run get` | read | Get a run's status, per-flow results, and links. |
76
+ | `qawolf tag create` | write | Create a tag on the caller's team. Tags select flows in run.create. |
77
+ | `qawolf tag list` | read | List the team's tags, alphabetical by name. Tag names select flows in run.create. |
68
78
 
69
79
  <!-- commands-table:end -->
70
80
 
@@ -72,12 +82,3 @@ Kinds: `read` calls the QA Wolf API without changing anything; `write`
72
82
  changes team state; `local` only affects this machine. A parenthesized
73
83
  note like `local (read with --remote)` means that flag makes the command
74
84
  call the QA Wolf API and require auth.
75
-
76
- ## Typical tasks
77
-
78
- - Trigger a run of flows on QA Wolf: `qawolf run create --help` for the
79
- required flags, then run it once and report the returned run id.
80
- - Run flows locally during development: `qawolf flows run` (use
81
- `qawolf install` first if dependencies are missing; `qawolf doctor` when
82
- something is broken).
83
- - Get flows for an environment: `qawolf flows pull`.