@testrigor/testrigor-cli 2.0.0 → 2.0.2

package/README.md

@@ -72,7 +72,8 @@ testrigor test-suite run <test-suite-id> --token <token> --localhost --local-tes
 The CLI will:
 
 - Detect it's a mobile suite
-- Start the mobile server (Appium) automatically
+- Install the mobile server (Appium) on the first mobile run, into `~/.testrigor/appium-server` (needs `npm` and registry access once)
+- Start the mobile server automatically
 - Open a tunnel to TestRigor cloud
 - Run the test on your local device
 - Stop everything when done
@@ -102,6 +103,11 @@ This overrides the device config stored in the test suite and forces mobile mode
 
 Every push to `master` runs the CircleCI `publish` workflow. It builds the tarballs, then publishes the package to npm under the `latest` tag. npm refuses to republish an existing version, so a change is only released when it bumps the version.
 
+Pull requests to `master` must pass two CircleCI checks before they can be merged:
+
+- `ci/circleci: test` runs the unit tests and the linter (`npm test`).
+- `ci/circleci: check-version` fails unless the version in `package.json` is higher than every version on npm and matches `package-lock.json`. Every PR needs a version bump, including ones that only change docs or CI. Run the same check locally with `npx ts-node scripts/check-version.ts`.
+
 1. Pick the [semver](https://semver.org) bump: `patch` for fixes, `minor` for new flags or commands, `major` for breaking changes.
 2. Bump the version with npm (don't edit `package.json` by hand):
 
@@ -110,186 +116,7 @@ Every push to `master` runs the CircleCI `publish` workflow. It builds the tarba
    npm version patch --no-git-tag-version
    ```
 
-   This updates the version in `package.json` and in both root entries of `package-lock.json` (`version` and `packages[""].version`). `--no-git-tag-version` stops npm from creating its own commit and `v*` tag. npm also runs the `version` script (`oclif readme && git add README.md`). That script loads the commands from `dist`, which is why you build first. It only rewrites README sections between oclif markers such as `<!-- commands -->
-* [`testrigor authenticate`](#testrigor-authenticate)
-* [`testrigor help [COMMANDS]`](#testrigor-help-commands)
-* [`testrigor test-suite config`](#testrigor-test-suite-config)
-* [`testrigor test-suite run [TESTSUITEID]`](#testrigor-test-suite-run-testsuiteid)
-* [`testrigor test-suite validate-syntax [TESTSUITEID]`](#testrigor-test-suite-validate-syntax-testsuiteid)
-
-## `testrigor authenticate`
-
-Set your testRigor authentication token
-
-```
-USAGE
-  $ testrigor authenticate [--token <value>]
-
-FLAGS
-  --token=<value>  API authentication token to store, instead of prompting for it
-
-DESCRIPTION
-  Set your testRigor authentication token
-
-EXAMPLES
-  $ testrigor authenticate
-
-  Prompts for your API authentication token
-
-  $ testrigor authenticate --token YOUR_TOKEN
-
-  Sets the token without prompting (for CI and scripts)
-
-  Use 'testrigor test-suite config' to set default test suite ID separately
-
-  Config will be stored in ~/.testrigor/testrigor.yml
-```
-
-_See code: [src/commands/authenticate.ts](https://github.com/TestRigor/testrigor-cli/blob/v2.0.0/src/commands/authenticate.ts)_
-
-## `testrigor help [COMMANDS]`
-
-Display help for testrigor.
-
-```
-USAGE
-  $ testrigor help [COMMANDS...] [-n]
-
-ARGUMENTS
-  [COMMANDS...]  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for testrigor.
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
-
-## `testrigor test-suite config`
-
-Configure test suite settings and default test suite ID
-
-```
-USAGE
-  $ testrigor test-suite config [--default <value> | --delete | --show]
-
-FLAGS
-  --default=<value>  Set the default test suite ID
-  --delete           Remove the default test suite ID
-  --show             Show current configuration
-
-DESCRIPTION
-  Configure test suite settings and default test suite ID
-
-EXAMPLES
-  $ testrigor test-suite config --default TEST-SUITE-ID
-
-  $ testrigor test-suite config --show
-
-  $ testrigor test-suite config --delete
-```
-
-_See code: [src/commands/test-suite/config.ts](https://github.com/TestRigor/testrigor-cli/blob/v2.0.0/src/commands/test-suite/config.ts)_
-
-## `testrigor test-suite run [TESTSUITEID]`
-
-Run all tests of a Test Suite
-
-```
-USAGE
-  $ testrigor test-suite run [TESTSUITEID] [--auth-token <value>] [-t <value>] [--min-port <value>] [--max-port
-    <value>] [--verbose] [-w] [--branch <value> --commit <value>] [--localhost] [--url <value>]
-    [--junit-report-save-path <value>] [--variables-path <value>] [--test-cases-path <value>] [--rules-path <value>]
-    [--settings-path <value>] [--local-test-nodes-path <value>] [--test-case-uuid <value>...] [--auto-create-ai-rules]
-    [--explicit-mutations] [--labels <value>...] [--excluded-labels <value>...] [--base-url-web <value>] [--base-url-api
-    <value>] [--chrome-extension <value>... | --file-path <value>] [--xray-execution-key <value>]
-
-ARGUMENTS
-  [TESTSUITEID]  The test suite id (optional if set in config)
-
-FLAGS
-  -w, --async                           Don't wait for the test suite to finish
-      --auto-create-ai-rules            Enable auto create AI based rules
-      --base-url-api=<value>            Base URL for API2 (e.g., https://api2.testrigor.com)
-      --base-url-web=<value>            Base URL for web interface (e.g., https://app.testrigor.com)
-      --branch=<value>                  [env: TR_BRANCH] The branch name
-      --chrome-extension=<value>...     Chrome extension: "name=EXT_NAME file=PATH_TO_CRX"
-      --commit=<value>                  [env: TR_COMMIT] The commit
-      --excluded-labels=<value>...      Not run tests of specific labels
-      --explicit-mutations              In cases where you are always using mutations, such as storing test cases in
-                                        your own repository, and you always send us the set of test cases you have
-                                        through our API you should send "--explicit-mutations"
-      --file-path=<value>               Path to the file stored locally. It will upload the new file to be used. File
-                                        type should be according to the file type accepted for the Test Suite type of
-                                        testing. If the parameter --url is used, this parameter will be ignored.
-      --junit-report-save-path=<value>  JUnit report save path
-      --labels=<value>...               Run tests of specific labels
-      --local-test-nodes-path=<value>   Path to a YAML or JSON file with local test nodes configuration
-      --localhost                       Localhost run (auto-detects web vs mobile)
-      --max-port=<value>                [default: 50000] Max port for tunnel
-      --min-port=<value>                [default: 40000] Min port for tunnel
-      --rules-path=<value>              Rules path
-      --settings-path=<value>           Settings path
-      --test-case-uuid=<value>...       Test case uuid (can be repeated). Requires --url (web) or --file-path (mobile
-                                        app upload).
-      --test-cases-path=<value>         Test cases files
-      --url=<value>                     The url
-      --variables-path=<value>          Variables path
-      --xray-execution-key=<value>      Reuse an existing Xray Cloud Test Execution by key (e.g. XR-123) instead of
-                                        creating a new one. Optional; leave blank to create a new execution.
-
-GLOBAL FLAGS
-  -t, --token=<value>       Suite authentication token
-      --auth-token=<value>  Personal authentication token
-      --verbose             Verbose output
-
-DESCRIPTION
-  Run all tests of a Test Suite
-```
-
-_See code: [src/commands/test-suite/run.ts](https://github.com/TestRigor/testrigor-cli/blob/v2.0.0/src/commands/test-suite/run.ts)_
-
-## `testrigor test-suite validate-syntax [TESTSUITEID]`
-
-Validate step syntax against a test suite's reusable rules, without running the steps
-
-```
-USAGE
-  $ testrigor test-suite validate-syntax [TESTSUITEID] [--auth-token <value>] [-t <value>] [--min-port <value>] [--max-port
-    <value>] [--verbose] [--steps <value> | --test-cases-path <value>] [--base-url-api <value>] [--rules-path <value>]
-    [--explicit-mutations]
-
-ARGUMENTS
-  [TESTSUITEID]  The test suite id (optional if set in config)
-
-FLAGS
-  --base-url-api=<value>     Base URL for API2 (e.g., https://api2.testrigor.com)
-  --explicit-mutations       Validate using only the supplied rules instead of merging them with the suite's saved rules
-  --max-port=<value>         [default: 50000] Max port for tunnel
-  --min-port=<value>         [default: 40000] Min port for tunnel
-  --rules-path=<value>       Ad hoc reusable rules to validate against, for rules not yet saved to this suite (same glob
-                             format as `test-suite run --rules-path`)
-  --steps=<value>            Raw step text to validate directly
-  --test-cases-path=<value>  Test case files to validate (same glob format as `test-suite run --test-cases-path`)
-
-GLOBAL FLAGS
-  -t, --token=<value>       Suite authentication token
-      --auth-token=<value>  Personal authentication token
-      --verbose             Verbose output
-
-DESCRIPTION
-  Validate step syntax against a test suite's reusable rules, without running the steps
-
-EXAMPLES
-  $ testrigor test-suite validate-syntax <test-suite-id> --steps "click \"Login\""
-
-  $ testrigor test-suite validate-syntax <test-suite-id> --test-cases-path "test_cases/**/*.{yaml,txt}"
-```
-
-_See code: [src/commands/test-suite/validate-syntax.ts](https://github.com/TestRigor/testrigor-cli/blob/v2.0.0/src/commands/test-suite/validate-syntax.ts)_
-<!-- commandsstop -->`, so this README currently stays unchanged.
+   This updates the version in `package.json` and in both root entries of `package-lock.json` (`version` and `packages[""].version`). `--no-git-tag-version` stops npm from creating its own commit and `v*` tag. npm also runs the `version` script (`oclif readme && git add README.md`). That script loads the commands from `dist`, which is why you build first. It only rewrites README sections between oclif's marker comments (`commands`, `usage`, `toc`). This README has none, so it stays unchanged. Don't write those markers literally anywhere in the README, not even in code spans: `oclif readme` also runs on every publish and would insert the command docs there.
 3. Check that the diff only touches the version fields, then build and test from the lockfile:
 
    ```