chore: publish

- appium@2.10.3
 - @appium/base-driver@9.10.3
 - @appium/base-plugin@2.2.39
 - @appium/doctor@2.1.6
 - @appium/docutils@1.0.15
 - @appium/driver-test-support@0.6.3
 - @appium/fake-plugin@3.1.43
 - @appium/images-plugin@3.0.14
 - @appium/logger@1.4.2
 - @appium/plugin-test-support@0.3.38
 - @appium/support@5.0.3
 - @appium/test-support@3.0.43
 - @appium/types@0.20.3

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -61,8 +61,8 @@ body:
       value: |
           - Operating system:
           - Appium server version (output of `appium --version`):
-          - Appium driver(s) and their version(s):
-          - Appium plugin(s) and their version(s):
+          - Appium driver(s) and their version(s) (`appium driver list`):
+          - Appium plugin(s) and their version(s) (`appium plugin list`):
           - Node.js version (output of `node --version`):
           - `npm` version (output of `npm --version`):
           - Last component(s) version which did _not_ exhibit the problem:

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: ❓ Question 
+    url: https://discuss.appium.io/
+    about: Please use the Appium forum for questions

.github/PULL_REQUEST_TEMPLATE.md

@@ -20,7 +20,7 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating
 - [ ] I have signed the CLA
 - [ ] Lint and unit tests pass locally with my changes
 - [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] I have added necessary documentation (if appropriate)
+- [ ] I have added the necessary documentation (if appropriate)
 - [ ] Any dependent changes have been merged and published in downstream modules
 
 ## Further comments

.github/labeler.yml

@@ -48,16 +48,6 @@ labels:
     matcher:
       files: ['packages/base-driver/**']
 
-  - label: '@appium/eslint-config-appium'
-    sync: true
-    matcher:
-      files: ['packages/eslint-config-appium/**']
-
-  - label: '@appium/eslint-config-appium-ts'
-    sync: true
-    matcher:
-      files: ['packages/eslint-config-appium-ts/**']
-
   - label: '@appium/base-plugin'
     sync: true
     matcher:
@@ -78,6 +68,16 @@ labels:
     matcher:
       files: ['packages/driver-test-support/**']
 
+  - label: '@appium/eslint-config-appium'
+    sync: true
+    matcher:
+      files: ['packages/eslint-config-appium/**']
+
+  - label: '@appium/eslint-config-appium-ts'
+    sync: true
+    matcher:
+      files: ['packages/eslint-config-appium-ts/**']
+
   - label: '@appium/execute-driver-plugin'
     sync: true
     matcher:
@@ -98,6 +98,11 @@ labels:
     matcher:
       files: ['packages/images-plugin/**']
 
+  - label: '@appium/logger'
+    sync: true
+    matcher:
+      files: ['packages/logger/**']
+
   - label: '@appium/opencv'
     sync: true
     matcher:
@@ -123,6 +128,11 @@ labels:
     matcher:
       files: ['packages/support/**']
 
+  - label: '@appium/strongbox'
+    sync: true
+    matcher:
+      files: ['packages/strongbox/**']
+
   - label: '@appium/test-support'
     sync: true
     matcher:
@@ -142,8 +152,3 @@ labels:
     sync: true
     matcher:
       files: ['packages/universal-xml-plugin/**']
-  
-  - label: '@appium/strongbox'
-    sync: true
-    matcher:
-      files: ['packages/strongbox/**']

.github/workflows/auto-labeler.yml

@@ -13,4 +13,4 @@ jobs:
     name: Auto-Label PRs
     runs-on: ubuntu-latest
     steps:
-      - uses: fuxingloh/multi-labeler@v2
+      - uses: fuxingloh/multi-labeler@v4

.github/workflows/build.yml

@@ -53,11 +53,11 @@ jobs:
   prepare_matrix:
     runs-on: ubuntu-latest
     outputs:
-      versions: ${{ steps.generate-matrix.outputs.versions }}
+      versions: ${{ steps.generate-matrix.outputs.active }}
     steps:
-    - name: Select 2 most recent LTS versions of Node.js
+    - name: Select all active LTS versions of Node.js
       id: generate-matrix
-      run: echo "versions=$(curl -s https://endoflife.date/api/nodejs.json | jq -c '[[.[] | select(.lts != false)][:2] | .[].cycle | tonumber]')" >> "$GITHUB_OUTPUT"
+      uses: msimerson/node-lts-versions@v1
 
   test:
     needs:

.github/workflows/deploy.yml

@@ -12,11 +12,11 @@ jobs:
   prepare_matrix:
     runs-on: ubuntu-latest
     outputs:
-      versions: ${{ steps.generate-matrix.outputs.versions }}
+      versions: ${{ steps.generate-matrix.outputs.active }}
     steps:
-    - name: Select 2 most recent LTS versions of Node.js
+    - name: Select all active LTS versions of Node.js
       id: generate-matrix
-      run: echo "versions=$(curl -s https://endoflife.date/api/nodejs.json | jq -c '[[.[] | select(.lts != false)][:2] | .[].cycle | tonumber]')" >> "$GITHUB_OUTPUT"
+      uses: msimerson/node-lts-versions@v1
 
   check:
     needs:

.github/workflows/on-hold.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check for "On Hold" label
-        uses: egmacke/action-check-label@v2
+        uses: egmacke/action-check-label@v3
         with:
           label: On Hold
           state: absent

.github/workflows/renovate.yml

@@ -25,6 +25,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Validate Renovate Config
-        uses: rinchsan/renovate-config-validator@v0.0.12
+        uses: rinchsan/renovate-config-validator@v0.2.0
         with:
           pattern: '{.renovaterc.json,renovate/default.json}'

.gitignore

@@ -37,6 +37,9 @@ certificate.key
 *.pdb
 .vs
 
+#vscode
+.history
+
 old
 .tern-project
 coverage
@@ -60,5 +63,6 @@ appium.zip
 **/build-fixtures/**
 *.tsbuildinfo
 packages/*/LICENSE
+\!packages/*/LICENSE
 local_appium_home
 *.tgz

.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run lint:commit -- --edit ${1}

.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run lint:staged

.wallaby.js

@@ -1,78 +0,0 @@
-'use strict';
-
-module.exports = (wallaby) => {
-  return {
-    compilers: {
-      '**/*.js': wallaby.compilers.typeScript({
-        allowJs: true,
-        allowSyntheticDefaultImports: true,
-        resolveJsonModule: true,
-        isolatedModules: true,
-      }),
-      '**/*.ts?(x)': wallaby.compilers.typeScript(),
-    },
-    debug: true,
-    env: {
-      type: 'node',
-    },
-    files: [
-      './packages/*/build/**/*',
-      './packages/*/lib/**/*.js',
-      './packages/*/lib/**/*.ts',
-      './packages/*/test/**/*helper*.js',
-      './packages/*/test/**/*helper*.ts',
-      './packages/*/test/**/*mock*.js',
-      './packages/*/test/**/*mock*.ts',
-      './packages/*/package.json',
-      './packages/*/tsconfig*.json',
-      './packages/*/test/**/fixture?(s)/**/*',
-      {
-        binary: true,
-        pattern: './packages/support/test/unit/assets/sample_binary.plist',
-      },
-      {
-        instrument: false,
-        pattern: './packages/support/test/unit/assets/sample_text.plist',
-      },
-      {
-        instrument: false,
-        pattern: './packages/base-driver/static/**/*',
-      },
-      {
-        instrument: false,
-        pattern: './packages/*/test/**/__snapshots__/**/*',
-      },
-      '!./packages/*/test/**/*-specs.js',
-      '!./packages/*/test/**/*.e2e.spec.js',
-      '!./packages/*/test/**/*.e2e.spec.ts',
-      '!**/local_appium_home/**',
-    ],
-    testFramework: 'mocha',
-    tests: [
-      './packages/*/test/unit/**/*.spec.js',
-      './packages/*/test/unit/**/*.spec.ts',
-      '!**/local_appium_home/**',
-    ],
-    workers: {
-      // restart: true,
-    },
-    setup(wallaby) {
-      // copied out of `./test/setup.js`
-
-      const chai = require('chai');
-      const chaiAsPromised = require('chai-as-promised');
-      const sinonChai = require('sinon-chai');
-
-      // The `chai` global is set if a test needs something special.
-      // Most tests won't need this.
-      global.chai = chai.use(chaiAsPromised).use(sinonChai);
-
-      // `should()` is only necessary when working with some `null` or `undefined` values.
-      global.should = chai.should();
-
-      const mocha = wallaby.testFramework;
-      mocha.timeout(10000);
-    },
-    runMode: 'onsave',
-  };
-};

CHANGELOG.md

@@ -4,7 +4,7 @@ Appium contains many different modules and supports a variety of drivers, plugin
 
 ## Main Appium Module
 
-* ### [Appium 2.0 Changelog](packages/appium/CHANGELOG.md)
+* ### [Appium 2 Changelog](packages/appium/CHANGELOG.md)
 * [Appium 1.x Changelog](https://github.com/appium/appium/blob/1.x/CHANGELOG.md)
 
 ## Appium Drivers / Clients / Plugins
@@ -23,6 +23,7 @@ Appium contains many different modules and supports a variety of drivers, plugin
 * [fake-driver](packages/fake-driver/CHANGELOG.md)
 * [fake-plugin](packages/fake-plugin/CHANGELOG.md)
 * [images-plugin](packages/images-plugin/CHANGELOG.md)
+* [logger](packages/logger/CHANGELOG.md)
 * [opencv](packages/opencv/CHANGELOG.md)
 * [plugin-test-support](packages/plugin-test-support/CHANGELOG.md)
 * [relaxed-caps-plugin](packages/relaxed-caps-plugin/CHANGELOG.md)
@@ -31,6 +32,5 @@ Appium contains many different modules and supports a variety of drivers, plugin
 * [support](packages/support/CHANGELOG.md)
 * [test-support](packages/test-support/CHANGELOG.md)
 * [tsconfig](packages/tsconfig/CHANGELOG.md)
-* [typedoc-plugin-appium](packages/typedoc-plugin-appium/CHANGELOG.md)
 * [types](packages/types/CHANGELOG.md)
 * [universal-xml-plugin](packages/universal-xml-plugin/CHANGELOG.md)

GOVERNANCE.md

@@ -15,12 +15,8 @@ The project is officially led by a Technical Committee (TC), currently
 consisting of:
 
 * [@jlipps](https://github.com/jlipps)
-* [@bootstraponline](https://github.com/bootstraponline)
-* [@penguinho](https://github.com/penguinho)
-* [@dandoveralba](https://github.com/dandoveralba)
 * [@mykola-mokhnach](https://github.com/mykola-mokhnach)
-* [@imurchie](https://github.com/imurchie)
-* [@TikhomirovSergey](https://github.com/TikhomirovSergey)
+* [@eglitise](https://github.com/eglitise)
 * [@KazuCocoa](https://github.com/KazuCocoa)
 
 They all represent different companies and different types of contribution to
@@ -31,7 +27,7 @@ changes to the project's governance processes.
 
 * Membership in the TC is granted by unanimous vote of current TC members.
 * TC members can step down at any time.
-* No more than 1/3 of TC members may belong to the same company.
+* No more than 1/3 (or 2, whichever is higher) of TC members may belong to the same company.
 * Changes to project governance require unanimous vote of the TC.
 
 ### Project Committers
@@ -50,55 +46,105 @@ and so on.
 * Any committer can decide to close a PR or issue if they determine the change doesn't suit the project.
 * Appium has a large ecosystem of repositories. Some are 'core' in the sense of being central subpackages with a lot of traffic like `appium/appium` or `appium/appium-ios-driver`. Others are 'peripheral' in the sense of receiving few changes, being maintained by 1 person or no one, etc..., like `appium/ruby_lib` or `appium/appium_thor` For 'core' repos, committers should not merge their own code straightaway. Like all contributors they should open a PR and get a +1 from another committer. For 'peripheral' repos for which they are the sole maintainer or for which they have a good understanding, it is obtuse to insist on another contributor's +1 and this rule should be relaxed in that case. In sum: use good judgment and don't ram code through without a review when you can help it.
 
-The current committers are (in addition to the TC members above):
+The current committers are (along with their primary areas(s) of ownership or maintenance):
 
-* [@hugs](https://github.com/hugs)
-* [@filmaj](https://github.com/filmaj)
-* [@aluedeke](https://github.com/aluedeke)
-* [@sebv](https://github.com/sebv)
-* [@vgrigoruk](https://github.com/vgrigoruk)
-* [@DylanLacey](https://github.com/DylanLacey)
-* [@maudineormsby](https://github.com/maudineormsby)
-* [@titusfortner](https://github.com/titusfortner)
-* [@bayandin](https://github.com/bayandin)
-* [@jdeff](https://github.com/jdeff)
-* [@moizjv](https://github.com/moizjv)
-* [@gempesaw](https://github.com/gempesaw)
-* [@Jonahss](https://github.com/Jonahss)
-* [@JamieEdge](https://github.com/JamieEdge)
-* [@saikrishna321](https://github.com/saikrishna321)
-* [@sravanmedarapu](https://github.com/sravanmedarapu)
-* [@peepa](https://github.com/peepa)
-* [@scottdixon](https://github.com/scottdixon)
-* [@drpy](https://github.com/drpy)
-* [@Astro03](https://github.com/Astro03)
-* [@sbonebrake](https://github.com/sbonebrake)
-* [@SrinivasanTarget](https://github.com/SrinivasanTarget)
-* [@triager](https://github.com/triager)
-* [@ddkjin](https://github.com/ddkjin)
-* [@stuartbrussell-intuit](https://github.com/stuartbrussell-intuit)
-* [@vmaxim](https://github.com/vmaxim)
-* [@Dan-Maor](https://github.com/Dan-Maor)
-* [@laolubenson](https://github.com/laolubenson)
-* [@Dor-bl](https://github.com/Dor-bl)
-* [@boneskull](https://github.com/boneskull)
-* [@mwakizaka](https://github.com/mwakizaka)
-* [@rerorero](https://github.com/rerorero)
-* [@tomriddly](https://github.com/tomriddly)
-* [@eglitise](https://github.com/eglitise)
+* [@dan-maor](https://github.com/Dan-Maor) - XCUITest driver and iOS internals
+* [@dor-bl](https://github.com/Dor-bl) - DotNet client
+* [@eglitise](https://github.com/eglitise) - Appium server, Inspector
+* [@jlipps](https://github.com/jlipps) - Appium server, Inspector
+* [@kazucocoa](https://github.com/KazuCocoa) - all Appium projects
+* [@laolubenson](https://github.com/laolubenson) - DotNet client
+* [@mwakizaka](https://github.com/mwakizaka) - XCUITest driver
+* [@mykola-mokhnach](https://github.com/mykola-mokhnach) - all Appium projects
+* [@rerorero](https://github.com/rerorero) - XCUITest/UIA2 driver
+* [@saikrishna321](https://github.com/saikrishna321) - Java client
+* [@srinivasantarget](https://github.com/SrinivasanTarget) - Java client
+* [@tomriddly](https://github.com/tomriddly) - appium-ios-device
+* [@valfirst](https://github.com/valfirst) - Java client
 
-### Contributors
+See [Emeritus Contributors](#emeritus-contributors) below for a list of people who formerly made
+significant contributions to the project but are no longer actively committing.
+
+### Other Contributors
 
 Other, less formal, kinds of contribution are outlined in our
-[CONTRIBUTING](/CONTRIBUTING.md) doc.
+[CONTRIBUTING](/CONTRIBUTING.md) doc. We also very much appreciate those who spend their valuable
+time assisting with the [Appium forums](https://discuss.appium.io). Current high-level forum
+contributors and mods include:
+
+* [aleksei](https://discuss.appium.io/u/aleksei/summary)
+* [wreed](https://discuss.appium.io/u/wreed/summary)
 
 ### Sponsorship
 
-The Appium project welcomes sponsorship of various organizations. Specific
-details are not yet available but in general we will accept monetary donations,
-contribution of code, contribution of dedicated committers, or donations of
-other goods or service (internet hosting, etc...). To begin the conversation,
-reach out to one of the TC members.
+The Appium project welcomes the sponsorship of individuals and organizations. There are two types
+of sponsorship: those related to contributions of Appium maintenance and leadership, and those
+related to contributions of funds. Both are extremely important to the ongoing health of the
+project. Financial sponsorship is mediated through our [OpenCollective page](https://opencollective.com/appium).
+Sponsorship tiers and benefits are described below:
+
+- **Development Partners**: The primary need of any open source project is for sustained maintenance and contributorship. Companies that officially sponsor such development with dedicated employee time are recognized as Development Partners, and receive the same benefits as the highest tier of financial sponsorship. To be considered a Development Partner, a company must devote at least 50% of a full-time employee's time to Appium maintenance. This means that the contributors designated by the company must have been appointed as "committers" in good standing of one or more core Appium repositories. (See above for a description of how to become a committer).
+- **Strategic Partners**: Representing the highest tier of ongoing financial support for the project, Strategic Partners are what make our compensation scheme for contributors possible, and we thank them for their significant investment into the project! More than financial contribution, Strategic Partners help elevate Appium's position in the industry through marketing and evangelism efforts, and partner with the Appium team to help make Appium better. Along with the Development Partners, Strategic Partners have their logos displayed prominently on our website, and have the ability to link to their Appium-related products in a few relevant places in our documentation.
+- **Gold, Silver, and Bronze Sponsors**: these sponsorship levels correspond to different amounts of recurring financial contribution that generously support our contributor compensation scheme. Sponsors at these levels also have the opportunity to display their logo on our website.
+- **Backers**: individuals who benefit from the Appium project can also donate on a one-time or recurring basis, at any amount, and will be recognized as Backers for their contribution!
+
+To become a sponsor at one of these levels, follow the process indicated at the [OpenCollective
+page](https://opencollective.com/appium).
+
+### Compensation Scheme
+
+With funds received through sponsorship, the Appium project wants to incentivize contributions of
+code, documentation efforts, maintenance, and project leadership. We have developed a scheme
+(inspired by one developed at the [WebdriverIO](https://github.com/webdriverio/webdriverio)
+project) for disbursing funds on a monthly basis to those who contribute to the project, as well as
+some other "upstream" open source projects.
+
+Each month, 15% of sponsorship funds received will be donated to upstream projects, based on the
+discretion of the current TC. At this point, no attempt will be made to formalize quantitative
+notions of relevance. If you manage a project upstream of Appium and would like to be considered as
+part of this donation group, give us a shout!
+
+Of the remaining 85% of sponsorship funds, 70% (roughly 60% of the original total) will go to
+project Committers (i.e., those in a role of maintenance), and 30% (roughly 25% of the original
+total) will go to Contributors (i.e., those making one-off or periodic contributions). The way that
+Committers and Contributors are paid for their efforts differs.
+
+For Committers, each Committer will keep a monthly time sheet of hours contributed to the project.
+At the end of each month, the hours tracked from all Committers will be totalled, and then the
+Committer-allocated funds will be disbursed (via OpenCollective) on a pro rata basis. Within this
+scheme, Committers agree not to submit hours worked as part of their employment with a Development
+Partner (since this is part of the "sponsorship" contribution of the Development Partner).
+
+For Contributors, when they make contributions which are successfully merged into the project,
+a Committer can discretionarily assign a "value tier" to the contribution. The "value tiers" and
+corresponding payouts are as follows:
+
+- XS: a trivial change (e.g. a typo change or applying of an automatically suggested security
+patch). \$0.
+- S: a small but useful change. \$25.
+- M: a medium-small or slightly more complex change. \$50.
+- L: a very valuable or sizable change. \$100.
+- XL: a massive change or set of changes. \$500.
+
+At the end of each month, Committers will total up the number of changes receiving potential
+payout. If the total amount of funds allocated for Contributor payout exceeds the total amount to
+be paid, then each Contributor will receive an OpenCollective link to claim their funds. If not
+enough funds exist to cover all payouts, then the payout amounts will be scaled down in a pro rata
+fashion.
+
+The scope for Committer or Contributor payouts is work completed within any "core" Appium
+repository (i.e., those officially maintained by the Appium team, residing within the Appium
+organization on GitHub, under `https://github.com/appium`).
+
+Some disclaimers: Payments will happen exclusively via OpenCollective. Recipients of funds are
+responsible for maintaining their OpenCollective account in a fashion where funds can be disbursed,
+and are responsible for any and all tax, financial, or legal consequences of receiving money in
+this way. Receipt of funds from this scheme holds the Appium project and the OpenJS Foundation free
+of any claim or obligation. While this document exists to clearly and publicly lay out the terms
+under which payments are generally made, the TC retains the right to grant or withhold funding on
+a discretionary of special basis. Basically, this scheme is run at the project's discretion, and is
+not a public service. Making contributions to the project under this scheme does not obligate the
+project to pay you for such work, or otherwise compensate you in any way.
 
 ### Raising Issues Related to Governance
 
@@ -106,3 +152,35 @@ This governance model necessarily leaves many situations unspecified. If
 questions arise as to how a given situation should proceed according to the
 overall goals of the project, the best thing to do is to open a GitHub issue
 and ping the TC members.
+
+### Emeritus Contributors
+
+* [@aluedeke](https://github.com/aluedeke)
+* [@astro03](https://github.com/Astro03)
+* [@bayandin](https://github.com/bayandin)
+* [@boneskull](https://github.com/boneskull)
+* [@bootstraponline](https://github.com/bootstraponline)
+* [@dandoveralba](https://github.com/dandoveralba)
+* [@ddkjin](https://github.com/ddkjin)
+* [@drpy](https://github.com/drpy)
+* [@dylanLacey](https://github.com/DylanLacey)
+* [@filmaj](https://github.com/filmaj)
+* [@gempesaw](https://github.com/gempesaw)
+* [@hugs](https://github.com/hugs)
+* [@imurchie](https://github.com/imurchie)
+* [@jamieEdge](https://github.com/JamieEdge)
+* [@jdeff](https://github.com/jdeff)
+* [@jonahss](https://github.com/Jonahss)
+* [@maudineormsby](https://github.com/maudineormsby)
+* [@moizjv](https://github.com/moizjv)
+* [@peepa](https://github.com/peepa)
+* [@penguinho](https://github.com/penguinho)
+* [@sbonebrake](https://github.com/sbonebrake)
+* [@scottdixon](https://github.com/scottdixon)
+* [@sebv](https://github.com/sebv)
+* [@sravanmedarapu](https://github.com/sravanmedarapu)
+* [@stuartbrussell-intuit](https://github.com/stuartbrussell-intuit)
+* [@tikhomirovSergey](https://github.com/TikhomirovSergey)
+* [@titusfortner](https://github.com/titusfortner)
+* [@vgrigoruk](https://github.com/vgrigoruk)
+* [@vmaxim](https://github.com/vmaxim)

README.md

@@ -2,7 +2,7 @@
 
 <p align="center">
    <a href="https://appium.io/">
-      <img alt="Appium" src="https://raw.githubusercontent.com/appium/appium/master/packages/appium/docs/assets/images/appium-logo-horiz.png" width="500">
+      <img alt="Appium" src="https://raw.githubusercontent.com/appium/appium/master/packages/appium/docs/overrides/assets/images/appium-logo-horiz.png" width="500">
    </a>
 </p>
 <p align="center">
@@ -178,8 +178,46 @@ cross-platform native app automation, for mobile and beyond!
 If you are looking for a more comprehensive description of what this is all about, please read our
 documentation on [How Does Appium Work?](https://appium.io/docs/en/latest/intro/appium/).
 
+## Sponsors
+
+Appium has a [Sponsorship Program](GOVERNANCE.md#sponsorship)! If you or your company uses Appium
+and wants to give back financially to the project, we use these funds to [encourage development and
+contributions](GOVERNANCE.md#compensation-scheme), as well as support other open source projects we
+rely on. [Become a sponsor](https://opencollective.com/appium) via our OpenCollective page.
+
+### Development and Strategic Partners
+
+Appium is incredibly grateful to our Development and Strategic Partners for their sustained
+contribution of project development and leadership!
+
+<p align="center">
+  <a href="https://www.headspin.io/solutions/appium-mobile-test-automation"><img src="packages/appium/docs/overrides/assets/images/sponsor-logo-headspin.png"
+width="275" alt="HeadSpin" /></a>
+</p>
+
+<p align="center">
+  <a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+    <picture>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" media="(prefers-color-scheme: dark)"/>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-light.png" media="(prefers-color-scheme: light)"/>
+      <img src="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" width="300" alt="Browserstack"/>
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://saucelabs.com/resources/blog/appium-strategic-partner"><img src="packages/appium/docs/overrides/assets/images/sponsor-logo-sauce.png"
+width="300" alt="Sauce Labs" /></a>
+</p>
+
+### Other Sponsors
+
+A full list of sponsors is available at our [Sponsors page](SPONSORS.md).
+
 ## License
 
 [Apache-2.0](./LICENSE)
 
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium?ref=badge_large)
+
+`@appium/logger` package is under [ISC](./packages/logger/LICENSE) License.

SPONSORS.md

@@ -0,0 +1,48 @@
+# Sponsors & Backers
+
+Appium is an Apache-2 licensed open source project whose development is made possible entirely by
+donations of time and money by individuals and companies who benefit from our software and our
+mission. If you'd like to join this amazing group and help ensure Appium's continued development
+and maintenance, you can contribute via [Appium's OpenCollective
+Hub](https://opencollective.com/appium).
+
+## Development Partners
+
+We are very grateful for the support of our Development Partners, who donate Appium development and
+maintenance as part of their employees' core job duties!
+
+<a href="https://www.headspin.io/solutions/appium-mobile-test-automation" target="_blank"><img
+src="packages/appium/docs/overrides/assets/images/sponsor-logo-headspin.png" width="250"/></a>
+
+## Strategic Partners
+
+We are very grateful for the financial and marketing support of our exclusive Strategic Partners,
+who contribute a significant ongoing investment of funds to help the project attract and reward
+contributors!
+
+<a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+  <picture>
+    <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" media="(prefers-color-scheme: dark)"/>
+    <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-light.png" media="(prefers-color-scheme: light)"/>
+    <img src="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" width="250" alt="Browserstack"/>
+  </picture>
+</a>
+<a style="padding-left: 1em" href="https://saucelabs.com/resources/blog/appium-strategic-partner" target="_blank"><img src="packages/appium/docs/overrides/assets/images/sponsor-logo-sauce.png" width="250"/></a>
+
+## Gold Sponsors
+
+<a href="https://opencollective.com/appium" target="_blank"><img src="https://opencollective.com/appium/tiers/gold-sponsor.svg?avatarHeight=100&button=false"/></a>
+
+[Become a Gold Sponsor](https://opencollective.com/appium/contribute/gold-sponsor-72877/checkout?interval=month&amount=500&contributeAs=me)
+
+## Silver Sponsors
+
+<a href="https://opencollective.com/appium" target="_blank"><img src="https://opencollective.com/appium/tiers/silver-sponsor.svg?avatarHeight=80&button=false"/></a>
+
+[Become a Silver Sponsor](https://opencollective.com/appium/contribute/silver-sponsor-72876/checkout?interval=month&amount=250&contributeAs=me)
+
+## Bronze Sponsors
+
+<a href="https://opencollective.com/appium" target="_blank"><img src="https://opencollective.com/appium/tiers/sponsors.svg?avatarHeight=60&button=false"/></a>
+
+[Become a Bronze Sponsor](https://opencollective.com/appium/contribute/sponsors-70690/checkout?interval=month&amount=100&contributeAs=me)

commitlint.config.js

@@ -1,11 +0,0 @@
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-  rules: {
-    'body-leading-blank': [0],
-    'body-max-line-length': [0],
-    'footer-max-line-length': [0],
-    'header-max-length': [0],
-    'subject-case': [0],
-    'subject-full-stop': [0],
-  },
-};

package.json

@@ -44,13 +44,10 @@
     "docs:preview": "npm run -w packages/appium build:docs:preview",
     "doctor": "node ./packages/doctor",
     "generate-docs": "npm run --workspace=packages/appium generate-docs",
-    "husky-install": "husky install",
     "lint": "eslint .",
     "lint:ci": "eslint --quiet .",
-    "lint:commit": "commitlint",
     "lint:fix": "run-s \"lint -- --fix\"",
-    "lint:staged": "lint-staged",
-    "prepare": "run-p husky-install rebuild",
+    "prepare": "run-p rebuild",
     "prepublishOnly": "run-s rebuild",
     "preversion": "run-s rebuild",
     "version": "run-s sync-pkgs stage-synced-pkgs",
@@ -62,9 +59,10 @@
     "start": "appium",
     "sync-pkgs": "run-p sync-pkgs:*",
     "sync-pkgs:appium-readme": "sync-monorepo-packages --force --no-package-json --packages=packages/appium README.md",
-    "sync-pkgs:common-fields": "sync-monorepo-packages --fields=author,license,bugs,homepage,engines",
+    "sync-pkgs:common-fields:default": "sync-monorepo-packages --packages=\"!packages/logger\" --fields=author,license,bugs,homepage,engines",
+    "sync-pkgs:common-fields:logger": "sync-monorepo-packages --packages=\"packages/logger\" --fields=author,bugs,homepage,engines",
     "sync-pkgs:keywords": "sync-monorepo-packages --field=keywords --packages=\"packages/*\" --packages=\"!packages/eslint-config-appium\" --packages=\"!packages/types\" --packages=\"!packages/eslint-config-appium-ts\" ",
-    "sync-pkgs:license": "sync-monorepo-packages --force --no-package-json LICENSE",
+    "sync-pkgs:license": "sync-monorepo-packages --force --no-package-json --packages=\"!packages/logger\" LICENSE",
     "test": "run-s test:quick",
     "test:ci": "run-s test:smoke test:unit test:types test:e2e",
     "test:e2e": "lerna run --concurrency=2 test:e2e",
@@ -84,64 +82,60 @@
   },
   "devDependencies": {
     "@colors/colors": "1.6.0",
-    "@commitlint/cli": "18.4.3",
-    "@commitlint/config-conventional": "18.4.3",
-    "@tsconfig/node14": "14.1.0",
-    "@types/chai": "4.3.11",
+    "@tsconfig/node14": "14.1.2",
+    "@types/chai": "4.3.16",
     "@types/chai-as-promised": "7.1.8",
-    "@types/diff": "5.0.9",
+    "@types/diff": "5.2.1",
     "@types/mocha": "10.0.6",
-    "@types/node": "20.10.6",
-    "@types/semver": "7.5.6",
-    "@types/sinon": "17.0.2",
+    "@types/node": "20.14.2",
+    "@types/semver": "7.5.8",
+    "@types/sinon": "17.0.3",
     "@types/sinon-chai": "3.2.12",
     "@types/source-map-support": "0.5.10",
     "@types/teen_process": "2.0.4",
     "@types/ws": "8.5.10",
     "@types/yargs": "17.0.32",
-    "@typescript-eslint/eslint-plugin": "6.17.0",
-    "@typescript-eslint/parser": "6.17.0",
+    "@typescript-eslint/eslint-plugin": "7.13.0",
+    "@typescript-eslint/parser": "7.13.0",
     "asyncbox": "3.0.0",
-    "chai": "4.3.10",
-    "chai-as-promised": "7.1.1",
-    "chai-webdriverio-async": "2.8.0",
+    "chai": "4.4.1",
+    "chai-as-promised": "7.1.2",
+    "chai-webdriverio-async": "3.0.0",
     "conventional-changelog-conventionalcommits": "7.0.2",
     "cpy-cli": "5.0.0",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-find-rules": "4.1.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-mocha": "10.2.0",
-    "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-mocha": "10.4.3",
+    "eslint-plugin-promise": "6.2.0",
     "fancy-log": "2.0.0",
     "finalhandler": "1.2.0",
     "get-port": "5.1.1",
-    "husky": "8.0.3",
-    "json-schema-to-typescript": "13.1.1",
-    "lerna": "8.0.1",
-    "lint-staged": "15.2.0",
+    "json-schema-to-typescript": "14.0.5",
+    "lerna": "8.1.3",
     "log-symbols": "4.1.0",
     "midnight-smoker": "8.0.0",
     "mjpeg-consumer": "2.0.0",
     "mjpeg-server": "0.3.1",
-    "mocha": "10.2.0",
+    "mocha": "10.4.0",
     "mocha-chai-jest-snapshot": "1.1.4",
-    "npm-run-all": "4.1.5",
-    "prettier": "3.1.1",
+    "npm-run-all2": "6.2.0",
+    "prettier": "3.3.2",
     "rewiremock": "3.14.5",
-    "rimraf": "5.0.5",
+    "rimraf": "5.0.7",
     "serve-static": "1.15.0",
-    "sinon": "17.0.1",
+    "sinon": "18.0.0",
     "sinon-chai": "3.7.0",
     "sync-monorepo-packages": "1.0.2",
     "through2": "4.0.2",
     "ts-node": "10.9.2",
-    "tsd": "0.30.2",
-    "typescript": "5.2.2",
+    "tsd": "0.31.0",
+    "typescript": "5.4.5",
     "validate.js": "0.13.1",
-    "webdriverio": "8.27.0",
-    "ws": "8.16.0",
+    "webdriverio": "8.38.2",
+    "ws": "8.17.0",
     "yaml-js": "0.3.1"
   },
   "engines": {
@@ -153,10 +147,10 @@
   },
   "overrides": {
     "@sidvind/better-ajv-errors": {
-      "ajv": "8.12.0"
+      "ajv": "8.16.0"
     },
     "ajv-formats": {
-      "ajv": "8.12.0"
+      "ajv": "8.16.0"
     },
     "http-cache-semantics": "4.1.1"
   }

packages/appium/CHANGELOG.md

@@ -3,6 +3,222 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.10.3](https://github.com/appium/appium/compare/appium@2.10.2...appium@2.10.3) (2024-06-11)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
+## [2.10.2](https://github.com/appium/appium/compare/appium@2.10.1...appium@2.10.2) (2024-06-11)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
+## [2.10.1](https://github.com/appium/appium/compare/appium@2.10.0...appium@2.10.1) (2024-06-11)
+
+**Note:** Version bump only for package appium
+
+
+
+
+
+## [2.10.0](https://github.com/appium/appium/compare/appium@2.9.0...appium@2.10.0) (2024-06-10)
+
+
+### Features
+
+* **appium:** Add a possibility to print logs in json format ([#20224](https://github.com/appium/appium/issues/20224)) ([1e86537](https://github.com/appium/appium/commit/1e86537e944f6beb7dbe72b35c267ae1dd9ebd36))
+* **appium:** Add session signature to all logs ([#20202](https://github.com/appium/appium/issues/20202)) ([#20214](https://github.com/appium/appium/issues/20214)) ([0363aab](https://github.com/appium/appium/commit/0363aab8ba4fe0ec49845db2f493001aa873578b)), closes [#20222](https://github.com/appium/appium/issues/20222)
+* **logger:** Add the debug level to the default logger ([#20219](https://github.com/appium/appium/issues/20219)) ([8ee7d07](https://github.com/appium/appium/commit/8ee7d07af4e2375d2eb7c23badaaac34685bc59c))
+* **support:** Move SecureValuesPreprocessor to @appum/logger ([#20228](https://github.com/appium/appium/issues/20228)) ([dbc3b66](https://github.com/appium/appium/commit/dbc3b668a0a7a815d23f1cae4207d435fc09034d))
+
+
+### Bug Fixes
+
+* **docutils:** update dependency lilconfig to v3.1.2 ([1828501](https://github.com/appium/appium/commit/1828501c66d0c5f8f295c67cd12d6691f8020780))
+* **docutils:** update dependency yaml to v2.4.5 ([6a08c95](https://github.com/appium/appium/commit/6a08c95fc9bda5cf39b8a6d98e5394658355a38e))
+* **types:** update dependency type-fest to v4.20.0 ([#20227](https://github.com/appium/appium/issues/20227)) ([ea00626](https://github.com/appium/appium/commit/ea00626091e3ce87f6e3ed7a61003295272835e3))
+
+
+
+## [2.9.0](https://github.com/appium/appium/compare/appium@2.8.0...appium@2.9.0) (2024-06-06)
+
+
+### Features
+
+* **appium:** Add session signature to all logs ([#20202](https://github.com/appium/appium/issues/20202)) ([b3f8a47](https://github.com/appium/appium/commit/b3f8a47c2d3fa029bdb5592d7130c6d1664e53b5))
+
+
+### Bug Fixes
+
+* **appium:** Revert changes in 20203 and 20202 ([#20209](https://github.com/appium/appium/issues/20209)) ([40def9d](https://github.com/appium/appium/commit/40def9dbdbde64706111900967d66735257b7404)), closes [#20202](https://github.com/appium/appium/issues/20202) [#20203](https://github.com/appium/appium/issues/20203)
+
+
+
+## [2.8.0](https://github.com/appium/appium/compare/appium@2.7.0...appium@2.8.0) (2024-06-06)
+
+
+### Features
+
+* **logger:** Add the 'debug' level to the default logger ([#20203](https://github.com/appium/appium/issues/20203)) ([7fd9d5f](https://github.com/appium/appium/commit/7fd9d5f6261b385c234580c2bfee4d576905458b))
+
+
+### Bug Fixes
+
+* add logger dependencies in package.json ([#20205](https://github.com/appium/appium/issues/20205)) ([3fbc4f1](https://github.com/appium/appium/commit/3fbc4f1fe07eadf9c7a2ef8fc9f4ba78dc3486a3))
+
+
+
+## [2.7.0](https://github.com/appium/appium/compare/appium@2.6.0...appium@2.7.0) (2024-06-06)
+
+
+### Features
+
+* **appium:** Replace npmlog with the local fork ([#20190](https://github.com/appium/appium/issues/20190)) ([8915934](https://github.com/appium/appium/commit/8915934270243bfb46c4d104a098ce1cc481b0ff))
+* **base-driver:** Make addition of search query params to cache optional ([#20195](https://github.com/appium/appium/issues/20195)) ([21316e9](https://github.com/appium/appium/commit/21316e94d05b2f97aa0349a82da229713e92446c))
+
+
+### Bug Fixes
+
+* **appium:** ensure ws close code is valid ([#20178](https://github.com/appium/appium/issues/20178)) ([65c47ac](https://github.com/appium/appium/commit/65c47acf5954bbf1947e896ef79c81a9b3c712a5))
+* **appium:** update dependency ajv to v8.16.0 ([ae7f74a](https://github.com/appium/appium/commit/ae7f74a0144d233653443622a84d49b1cb4e6222))
+* **docutils:** update dependency yaml to v2.4.3 ([848eb00](https://github.com/appium/appium/commit/848eb00afbd1cab76a6a1c3d0f4a2a0b1acee0d0))
+* **execute-driver-plugin:** update dependency webdriverio to v8.38.2 ([c8f9979](https://github.com/appium/appium/commit/c8f997973cc21673f95d02c92d43a2981b8713b8))
+* **support:** update dependency teen_process to v2.1.4 ([96a7a3f](https://github.com/appium/appium/commit/96a7a3f23bead7c1d18700550138cd2d70ce5e3c))
+* **types:** update dependency type-fest to v4.19.0 ([#20193](https://github.com/appium/appium/issues/20193)) ([db62358](https://github.com/appium/appium/commit/db62358dbac25de2a75fdc7493338d98b1422c84))
+
+
+
+## [2.6.0](https://github.com/appium/appium/compare/appium@2.5.4...appium@2.6.0) (2024-05-27)
+
+
+### Features
+
+* **appium:** Add --show-debug-info CLI argument ([#20108](https://github.com/appium/appium/issues/20108)) ([6f602d3](https://github.com/appium/appium/commit/6f602d3e501dbd9d44f6e7ba220f45ff1d4dfde8))
+* **appium:** prepare setup subcommand as shortcut for drivers/plugins installation ([#20102](https://github.com/appium/appium/issues/20102)) ([2b2fb18](https://github.com/appium/appium/commit/2b2fb185a6bc882717e4aa0580b0136bf5ae2942))
+* **base-driver:** Add env variables to control applications cache ([#20042](https://github.com/appium/appium/issues/20042)) ([4e8c91c](https://github.com/appium/appium/commit/4e8c91c8f647e545344d5b49282628413e1ccb19))
+
+
+### Bug Fixes
+
+* **appium:** Do not crash the process if there was an exception in a winston transport ([#20065](https://github.com/appium/appium/issues/20065)) ([0492fe4](https://github.com/appium/appium/commit/0492fe49dc34b3ef345a988bf56e49daf8dfcffe))
+* **appium:** update dependency ajv to v8.13.0 ([448e94e](https://github.com/appium/appium/commit/448e94ee50fa127ae93e657a3958726aa13e7df8))
+* **appium:** update dependency ajv to v8.14.0 ([e3dcd66](https://github.com/appium/appium/commit/e3dcd66714be603a8acbb3364f538c60772e76bd))
+* **appium:** update dependency ws to v8.17.0 ([395dc22](https://github.com/appium/appium/commit/395dc225e4d7f47dc55134fba9fb9306cabf7e19))
+* **docutils:** update dependency yaml to v2.4.2 ([0211174](https://github.com/appium/appium/commit/0211174300cf91c1cad2364d8ce3de7100139f5c))
+* **execute-driver-plugin:** update dependency webdriverio to v8.37.0 ([27ff9a0](https://github.com/appium/appium/commit/27ff9a00ef65a66aea8da8e3be5ffebb6d8c65e1))
+* **execute-driver-plugin:** update dependency webdriverio to v8.38.0 ([e80b682](https://github.com/appium/appium/commit/e80b6826efbe14ecfa6c0ff1f6aceb4db99b82d8))
+* **support:** update dependency axios to v1.7.1 ([11510cb](https://github.com/appium/appium/commit/11510cb1a5d50a20ced884e5404d0be1e04ff142))
+* **support:** update dependency axios to v1.7.2 ([a876f11](https://github.com/appium/appium/commit/a876f112b51dd25f70094b9e75330b9558050e42))
+* **support:** update dependency semver to v7.6.1 ([b5fd5b6](https://github.com/appium/appium/commit/b5fd5b6d2c585be8391b80ac67207da610e8ea64))
+* **support:** update dependency semver to v7.6.2 ([1b4f36c](https://github.com/appium/appium/commit/1b4f36cebe7aaf99976f24346b2d1325b79fc55c))
+* **support:** update dependency teen_process to v2.1.3 ([b34ce3c](https://github.com/appium/appium/commit/b34ce3cff0279be5bb5dcb9228f7e058d27a5e72))
+* **types:** update dependency type-fest to v4.18.2 ([#20103](https://github.com/appium/appium/issues/20103)) ([3b43be1](https://github.com/appium/appium/commit/3b43be17321f2ca16bac0abedabf9ef8cffa098a))
+* **types:** update dependency type-fest to v4.18.3 ([#20149](https://github.com/appium/appium/issues/20149)) ([d5369f8](https://github.com/appium/appium/commit/d5369f8b08e7439282c5a211e684b154cc9f0051))
+
+
+
+## [2.5.4](https://github.com/appium/appium/compare/appium@2.5.3...appium@2.5.4) (2024-04-21)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency webdriverio to v8.36.1 ([9ad20ff](https://github.com/appium/appium/commit/9ad20ff1c266923f3efe50bfe2ae4b1ab8ecb20a))
+
+
+
+## [2.5.3](https://github.com/appium/appium/compare/appium@2.5.2...appium@2.5.3) (2024-04-16)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency webdriverio to v8.36.0 ([#19998](https://github.com/appium/appium/issues/19998)) ([72f3284](https://github.com/appium/appium/commit/72f32848b68e6ef8c047f700ffd0be7d68c49aba))
+
+
+
+## [2.5.2](https://github.com/appium/appium/compare/appium@2.5.1...appium@2.5.2) (2024-04-08)
+
+
+### Bug Fixes
+
+* **appium:** make --log-filters work ([#19825](https://github.com/appium/appium/issues/19825)) ([0d5a0a5](https://github.com/appium/appium/commit/0d5a0a572787d913412bbfd70835e5ba8f94334c))
+* **appium:** update definitelytyped ([2687fa4](https://github.com/appium/appium/commit/2687fa47a0c2f11983e5ccb2ee17eaae9279469d))
+* **appium:** update definitelytyped ([68456b8](https://github.com/appium/appium/commit/68456b8aea3c6ae7225814748fb36d9d4117cc9f))
+* **appium:** update dependency ajv-formats to v3 ([#19957](https://github.com/appium/appium/issues/19957)) ([59ef09d](https://github.com/appium/appium/commit/59ef09d9558f1a6a9f4ee3d81d4cb0b7218706b4))
+* **appium:** update dependency winston to v3.12.0 ([8eb4e88](https://github.com/appium/appium/commit/8eb4e888f624acfc1d42977eeda2d4c1ae139efc))
+* **appium:** update dependency winston to v3.13.0 ([03f8dc9](https://github.com/appium/appium/commit/03f8dc9b18f226975f025ceda7e1d907de8b45d5))
+* **docutils:** update dependency lilconfig to v3.1.0 ([f92640a](https://github.com/appium/appium/commit/f92640a824644545b680e23c7f3ec7f51de9df98))
+* **docutils:** update dependency lilconfig to v3.1.1 ([e04e4e9](https://github.com/appium/appium/commit/e04e4e902a212cf17ca79b3edc0b7545a1af507b))
+* **docutils:** update dependency typescript to v5.4.2 ([#19876](https://github.com/appium/appium/issues/19876)) ([2448fa0](https://github.com/appium/appium/commit/2448fa0145620657ccc72b5637f1b7737fe52580))
+* **docutils:** update dependency yaml to v2.4.0 ([26ded7a](https://github.com/appium/appium/commit/26ded7a4cce1fa9bca28521e4b60cad0edacbe96))
+* **docutils:** update dependency yaml to v2.4.1 ([636d6b3](https://github.com/appium/appium/commit/636d6b3802268ec6532f9f3a958f304c6760d172))
+* **execute-driver-plugin:** update dependency webdriverio to v8.32.0 ([d25a0fc](https://github.com/appium/appium/commit/d25a0fca9b3a94880525fd956068f59427a40b26))
+* **execute-driver-plugin:** update dependency webdriverio to v8.32.1 ([ea8c74b](https://github.com/appium/appium/commit/ea8c74b372e73e88cf0303aa17db943014416e64))
+* **execute-driver-plugin:** update dependency webdriverio to v8.32.2 ([#19807](https://github.com/appium/appium/issues/19807)) ([6c034aa](https://github.com/appium/appium/commit/6c034aa84af573d36fa934c71d3d4ff328772553))
+* **execute-driver-plugin:** update dependency webdriverio to v8.32.3 ([f837a6a](https://github.com/appium/appium/commit/f837a6a9eaf34914ffdbfddcc3cb2f7e7427bc63))
+* **execute-driver-plugin:** update dependency webdriverio to v8.32.4 ([7516d41](https://github.com/appium/appium/commit/7516d4135a1eec37ba298f407254d825961795af))
+* **execute-driver-plugin:** update dependency webdriverio to v8.33.1 ([#19877](https://github.com/appium/appium/issues/19877)) ([0e6c3ee](https://github.com/appium/appium/commit/0e6c3eede250193fad390387ec494918367176d9))
+* **execute-driver-plugin:** update dependency webdriverio to v8.34.1 ([7fc7446](https://github.com/appium/appium/commit/7fc7446612f3257fa421dfec006d02730df10f59))
+* **execute-driver-plugin:** update dependency webdriverio to v8.35.1 ([63d7550](https://github.com/appium/appium/commit/63d7550d02f049a5c3bea5d27e7e8385d7698a4f))
+* **support:** update dependency @types/semver to v7.5.8 ([d1705e2](https://github.com/appium/appium/commit/d1705e2818d435b4c37cb70753af1de5427378e2))
+* **support:** update dependency axios to v1.6.8 ([bd6ab81](https://github.com/appium/appium/commit/bd6ab81c9408ab0f90fc25fc112f9257ec2973ad))
+
+
+
+## [2.5.1](https://github.com/appium/appium/compare/appium@2.5.0...appium@2.5.1) (2024-02-13)
+
+
+### Bug Fixes
+
+* **execute-driver-plugin:** update dependency webdriverio to v8.31.1 ([db0eec0](https://github.com/appium/appium/commit/db0eec05c58fe970351a309a01507cad824bdad2))
+* **support:** update dependency @types/semver to v7.5.7 ([bd8a92f](https://github.com/appium/appium/commit/bd8a92f588d40c97fbe51f8bd3b7835c96e9fe8f))
+* **support:** update dependency semver to v7.6.0 ([7b40a32](https://github.com/appium/appium/commit/7b40a3225ebe0f5976a26d05db2f22ba7b13a130))
+
+
+
+## [2.5.0](https://github.com/appium/appium/compare/appium@2.4.1...appium@2.5.0) (2024-02-06)
+
+
+### Features
+
+* **appium:** Set a proper exit code if any of required doctor checks fails ([#19617](https://github.com/appium/appium/issues/19617)) ([f4011f1](https://github.com/appium/appium/commit/f4011f17d4d03bc854c43462848a4c38427acb85))
+
+
+### Bug Fixes
+
+* **appium:** Tune warning messages about installed extensions ([#19612](https://github.com/appium/appium/issues/19612)) ([5cd9ca5](https://github.com/appium/appium/commit/5cd9ca5c21393c70d259f7525d2c9d35b7eeb2a2))
+* **execute-driver-plugin:** update dependency webdriverio to v8.27.2 ([35f1dba](https://github.com/appium/appium/commit/35f1dbabf6e852c4ae84ec128879bc7e61321a16))
+* **execute-driver-plugin:** update dependency webdriverio to v8.28.0 ([e8e0444](https://github.com/appium/appium/commit/e8e0444bd28d94963090065a813a4b10be665caa))
+* **execute-driver-plugin:** update dependency webdriverio to v8.28.6 ([da84efc](https://github.com/appium/appium/commit/da84efc42dd62b2be07a52dd4379791e2cef6eb2))
+* **execute-driver-plugin:** update dependency webdriverio to v8.28.8 ([1fdf117](https://github.com/appium/appium/commit/1fdf117c63f6e9871f4de3c0bd93ecbdb13a9235))
+* **execute-driver-plugin:** update dependency webdriverio to v8.29.0 ([6f0101e](https://github.com/appium/appium/commit/6f0101eb6343eb8b372e00a6b71d2b2ee909404c))
+* **execute-driver-plugin:** update dependency webdriverio to v8.29.1 ([fb0f8f7](https://github.com/appium/appium/commit/fb0f8f776c6a03174f4569efa60d817a930809cf))
+* **execute-driver-plugin:** update dependency webdriverio to v8.29.3 ([6dacb5e](https://github.com/appium/appium/commit/6dacb5e70ca3529a080f629f5245c2b676746e2c))
+* **execute-driver-plugin:** update dependency webdriverio to v8.29.7 ([52a6f96](https://github.com/appium/appium/commit/52a6f96e085ff13acdf8d5013673861b7e0da818))
+* **execute-driver-plugin:** update dependency webdriverio to v8.30.0 ([91320dd](https://github.com/appium/appium/commit/91320ddd02dca89a8cec258d0ab44a49d344d71c))
+* **support:** update dependency axios to v1.6.4 ([332cc48](https://github.com/appium/appium/commit/332cc48a09b5532a8d51f85f3a24785e2c754e00))
+* **support:** update dependency axios to v1.6.5 ([#19616](https://github.com/appium/appium/issues/19616)) ([ac73522](https://github.com/appium/appium/commit/ac73522351b31bd6c11972c61daa8b6b8d18fb91))
+* **support:** update dependency axios to v1.6.6 ([6313704](https://github.com/appium/appium/commit/6313704ee5a8ee3aee726eb512ef259b6fa1041c))
+* **support:** update dependency axios to v1.6.7 ([795092a](https://github.com/appium/appium/commit/795092a97f6d7569cccc4b5c166f52fef821514b))
+* **types:** update dependency type-fest to v4.10 ([#19694](https://github.com/appium/appium/issues/19694)) ([966d305](https://github.com/appium/appium/commit/966d305e5eade9369a3875243bcad951df88545c))
+* **types:** update dependency type-fest to v4.10.1 ([#19703](https://github.com/appium/appium/issues/19703)) ([501395c](https://github.com/appium/appium/commit/501395c9489320b84ab49ff78af4270f66070d62))
+
+
+
+## [2.4.1](https://github.com/appium/appium/compare/appium@2.4.0...appium@2.4.1) (2024-01-04)
+
+
+### Bug Fixes
+
+* **appium:** Properly handle version check for aliases ([474f3ce](https://github.com/appium/appium/commit/474f3ce092c68981655d9deba546a6202acea141))
+
+
+
 ## [2.4.0](https://github.com/appium/appium/compare/appium@2.3.0...appium@2.4.0) (2024-01-03)
 
 

packages/appium/README.md

@@ -2,7 +2,7 @@
 
 <p align="center">
    <a href="https://appium.io/">
-      <img alt="Appium" src="https://raw.githubusercontent.com/appium/appium/master/packages/appium/docs/assets/images/appium-logo-horiz.png" width="500">
+      <img alt="Appium" src="https://raw.githubusercontent.com/appium/appium/master/packages/appium/docs/overrides/assets/images/appium-logo-horiz.png" width="500">
    </a>
 </p>
 <p align="center">
@@ -178,8 +178,46 @@ cross-platform native app automation, for mobile and beyond!
 If you are looking for a more comprehensive description of what this is all about, please read our
 documentation on [How Does Appium Work?](https://appium.io/docs/en/latest/intro/appium/).
 
+## Sponsors
+
+Appium has a [Sponsorship Program](GOVERNANCE.md#sponsorship)! If you or your company uses Appium
+and wants to give back financially to the project, we use these funds to [encourage development and
+contributions](GOVERNANCE.md#compensation-scheme), as well as support other open source projects we
+rely on. [Become a sponsor](https://opencollective.com/appium) via our OpenCollective page.
+
+### Development and Strategic Partners
+
+Appium is incredibly grateful to our Development and Strategic Partners for their sustained
+contribution of project development and leadership!
+
+<p align="center">
+  <a href="https://www.headspin.io/solutions/appium-mobile-test-automation"><img src="packages/appium/docs/overrides/assets/images/sponsor-logo-headspin.png"
+width="275" alt="HeadSpin" /></a>
+</p>
+
+<p align="center">
+  <a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+    <picture>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" media="(prefers-color-scheme: dark)"/>
+      <source srcset="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-light.png" media="(prefers-color-scheme: light)"/>
+      <img src="packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png" width="300" alt="Browserstack"/>
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://saucelabs.com/resources/blog/appium-strategic-partner"><img src="packages/appium/docs/overrides/assets/images/sponsor-logo-sauce.png"
+width="300" alt="Sauce Labs" /></a>
+</p>
+
+### Other Sponsors
+
+A full list of sponsors is available at our [Sponsors page](SPONSORS.md).
+
 ## License
 
 [Apache-2.0](./LICENSE)
 
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fappium%2Fappium?ref=badge_large)
+
+`@appium/logger` package is under [ISC](./packages/logger/LICENSE) License.

packages/appium/docs/.gitignore

@@ -1,3 +1,4 @@
+en/latest
 en/assets
 ja/assets
 zh/assets

packages/appium/docs/assets/stylesheets/extra.css

@@ -1,6 +0,0 @@
-.md-source__fact--version {
-  display: none;
-}
-.md-source__fact:nth-child(1n + 2):before {
-  margin-left: 0 !important;
-}

packages/appium/docs/base-mkdocs.yml

@@ -8,8 +8,12 @@ copyright: Copyright &copy; 2012 OpenJS Foundation - <a href="#__consent">Change
 theme:
   logo: assets/images/appium-logo-white.png
   favicon: assets/images/appium-logo.png
+  custom_dir: overrides
 
 plugins:
+  blog:
+    enabled: true
+    post_excerpt: required
   redirects:
     redirect_maps:
       'intro/requirements.md': 'quickstart/requirements.md'
@@ -34,7 +38,7 @@ extra:
       link: https://twitter.com/AppiumDevs
   alternate:
     - name: English
-      link: /docs/en/ 
+      link: /docs/en/
       lang: en
     - name: 日本
       link: /docs/ja/

packages/appium/docs/en/blog/.authors.yml

@@ -0,0 +1,8 @@
+authors:
+  jlipps:
+    name: "Jonathan Lipps"
+    description: "Appium project lead. Learn more about Jonathan at https://jlipps.com"
+    avatar: "https://gravatar.com/avatar/fdaadd825d92709bcf7fe76dffa12c40681c6108c67bcddf19478b2d00e3794b.jpg"
+    slug: "jlipps"
+    url: "https://jlipps.com"
+

packages/appium/docs/en/blog/index.md

@@ -0,0 +1,2 @@
+# Appium Blog
+

packages/appium/docs/en/blog/posts/announcing-browserstack-as-strategic-partner.md

@@ -0,0 +1,46 @@
+---
+authors:
+  - jlipps
+date: 2024-06-10
+---
+
+# Announcing BrowserStack as Appium's Strategic Partner
+
+We have another exciting announcement for you! As part of our recently-announced [sponsorship and
+contributor compensation
+program](https://appium.io/docs/en/latest/blog/2024/05/14/announcing-appiums-sponsorship-program/),
+we are obviously in need of significant funding to support giving back to our contributor
+community. We are therefore extremely happy to announce one of our brand new exclusive Strategic Partners: <a
+href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">BrowserStack</a>!
+
+<!-- more -->
+
+<div style="text-align:center;width:100%">
+  <a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+    <img src="/docs/en/latest/assets/images/sponsor-logo-browserstack-dark.png#only-dark" width="300" />
+    <img src="/docs/en/latest/assets/images/sponsor-logo-browserstack-light.png#only-light" width="300" />
+  </a>
+</div>
+
+BrowserStack has long been recognized in the industry as having extensive support for Appium,
+allowing you to run functional and visual regression tests for your native and hybrid apps at scale
+across a variety of devices and platforms.
+
+As a token of this collaboration, BrowserStack is extending a special premium access of
+BrowserStack App Automate product to Appium users. Discover more about this special offer at
+[browserstack.com](https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium&utm_term=partannouncement)
+
+With the decision to come on board as Strategic Partner, BrowserStack is making a huge investment
+in Appium and the Appium community. BrowserStack is very interested in supporting the development
+of the Appium contributor base, and is proud to be a key part of our contributor compensation
+scheme. Without Strategic Partners like BrowserStack, we would not be able to maintain such
+a program! We welcome them with gratitude!
+
+**About BrowserStack**
+
+<em>BrowserStack is the world’s leading software testing platform powering over two million tests every
+day across 19 global data centers. BrowserStack helps Tesco, Shell, NVIDIA, Discovery, Wells Fargo,
+and over 50,000 customers deliver quality software at speed by moving testing to their Cloud.
+BrowserStack’s platform provides instant access to 20,000+ real mobile devices on a highly reliable
+cloud infrastructure that effortlessly scales as testing needs grow. With BrowserStack, Dev and QA
+teams can move fast while delivering an amazing experience for every customer.</em>

packages/appium/docs/en/blog/posts/announcing-headspin-as-development-partner.md

@@ -0,0 +1,47 @@
+---
+authors:
+  - jlipps
+date: 2024-06-06
+---
+
+# Announcing HeadSpin as Appium's Development Partner
+
+Recently, we announced a new [sponsorship and contributor compensation program](https://appium.io/docs/en/latest/blog/2024/05/14/announcing-appiums-sponsorship-program/) for the Appium
+project. As part of this program, we felt it was important to have a place to recognize those
+companies who make an extremely valuable kind of contribution to the project: dedicated maintainer
+time. Appium only survives because of the tireless efforts of the core maintainers, and some of us
+are only able to do this work because it is donated on behalf of our day jobs. We're therefore very
+excited to announce our first Development Partner: <a
+href="https://www.headspin.io/solutions/appium-mobile-test-automation">HeadSpin</a>!
+
+<!-- more -->
+
+<div style="text-align:center;width:100%">
+  <a href="https://www.headspin.io/solutions/appium-mobile-test-automation"><img
+src="/docs/en/latest/assets/images/sponsor-logo-headspin.png" style="width: 300px"/></a>
+</div>
+
+HeadSpin is a real device performance and UX analysis cloud, with full support for Appium. When you
+run your Appium tests on HeadSpin, you get access to comprehensive performance reports about your
+app, including potential network, system resource, or user experience issues. HeadSpin supports
+a variety of complex testing modes, including hooking up your own devices to the cloud, injecting
+and receiving video and audio to/from devices, working with media (streaming) platforms, and more.
+
+HeadSpin has been one of the Appium project's biggest supporters for a long time, and currently
+employs two of Appium's core maintainers, donating a significant portion of their time towards the
+development, maintenance, support, and leadership of open source Appium repos. HeadSpin has also
+worked hard towards Appium's vision of a robust Appium ecosystem, contributing several
+HeadSpin-maintained Appium drivers and plugins to the community:
+
+- A [Roku TV driver](https://github.com/headspinio/appium-roku-driver)
+- A [Tizen TV driver](https://github.com/headspinio/appium-tizen-tv-driver/)
+- A [LG webOS TV driver](https://github.com/headspinio/appium-lg-webos-driver/)
+- A [Unity game automation plugin](https://github.com/headspinio/appium-altunity-plugin)
+
+These are all free and open source Appium components that HeadSpin has donated to the community
+with the goal of fostering collaboration in these areas of media app automation.
+
+Looking to the future, HeadSpin plans to continue supporting Appium in significant ways, both as
+a Development Partner and a significant contributor to the Appium ecosystem. The Appium project is
+deeply indebted to HeadSpin for all of its support, and is proud to take this moment to recognize
+HeadSpin as our first official Development Partner!

packages/appium/docs/en/blog/posts/announcing-sauce-labs-as-strategic-partner.md

@@ -0,0 +1,36 @@
+---
+authors:
+  - jlipps
+date: 2024-06-10
+---
+
+# Announcing Sauce Labs as Appium's Strategic Partner
+
+The good news surrounding our new [sponsorship and contributor compensation
+program](https://appium.io/docs/en/latest/blog/2024/05/14/announcing-appiums-sponsorship-program/)
+just keeps coming! Effective immediately we are fortunate and excited to be able to welcome a new Strategic Partner to
+the Appium project: <a href="https://saucelabs.com/resources/blog/appium-strategic-partner">Sauce Labs</a>!
+
+<!-- more -->
+
+<div style="text-align:center;width:100%">
+  <a href="https://saucelabs.com/resources/blog/appium-strategic-partner"><img src="/docs/en/latest/assets/images/sponsor-logo-sauce.png" style="width: 300px"/></a>
+</div>
+
+Sauce Labs has a long history of support for the Appium project. In fact, Appium was initially
+incubated at Sauce Labs under the direction of [@jlipps](https://github.com/jlipps), in the early
+days of mobile automation. Sauce Labs always envisioned Appium as being a project for and by the
+community, and cemented this perspective in 2016 with the donation of Appium to the JS Foundation
+(now the [OpenJS Foundation](https://openjsf.org/)). To this day, developers associated with Sauce
+Labs continue to help maintain various parts of the Appium project.
+
+Now, Sauce Labs is making a further commitment to support Appium financially as a way to enable
+our new contributor compensation program. We're very excited about this program as a vehicle for
+getting more people involved in Appium's development and maintenance. With the help of Strategic
+Partners like Sauce Labs, our project will be better able to meet the needs of our constantly
+growing userbase, and attract new developers (like you?) to build the Appium ecosystem together.
+Needless to say, we are extremely grateful for Sauce Labs's support!
+
+**About Sauce Labs**
+
+<em>Sauce Labs is the leader in continuous quality. Our Platform for Test helps organizations transform software testing from a chore to a competitive advantage. With decades of expertise and deep roots in the Selenium and Appium open source communities, high performing software teams use our platform to execute any testing workload across thousands of different devices, browsers, and operating systems—anywhere, any time, and at any scale. For more information, please visit [saucelabs.com](https://saucelabs.com).</em>

packages/appium/docs/en/blog/posts/announcing-sponsorship-program.md

@@ -0,0 +1,48 @@
+---
+authors:
+  - jlipps
+date: 2024-05-14
+---
+
+# Announcing Appium's Sponsorship Program
+
+Over the last several months, the Appium team has been working on a sponsorship program that is
+designed to help give back to Appium's contributors as well as to recognize important partner
+individuals or companies in the industry. This program is now officially launching! Let's dive into
+some of the details.
+
+<!-- more -->
+
+First of all, the details and fine print will always be available at Appium's [Governance
+document](https://github.com/appium/appium/blob/master/GOVERNANCE.md), which outlines how the
+project is run, who makes project decisions, etc... This document will be kept up to date with the
+latest details of the program, so that's the place to bookmark for reference!
+
+As of now, Appium has opened up sponsorship opportunities via our [OpenCollective
+page](https://opencollective.com/appium). OpenCollective is a service which allows people to donate
+to open source groups. We've defined a number of giving tiers for donations, within a very wide
+range, and welcome any financial amount with gratitude! Based on the donation tier, sponsorship
+comes with a variety of benefits, including recognition at different places in the Appium repo,
+docs, and website. In addition to financial sponsorship, the project has decided to recognize
+significant donations of project leadership and maintenance efforts from companies who have
+invested heavily into Appium with their employees' time (we call these "Development Partners").
+
+What will the project do with the funds raised through this sponsorship program? We aim to give it
+all back to the Appium community! With the details again available at our [Governance document](https://github.com/appium/appium/blob/master/GOVERNANCE.md),
+we have implemented a scheme very much inspired by our friends at [WebdriverIO](https://webdriver.io/blog/2024/02/15/new-contributor-stipend-program) (thanks WDIO
+friends!) There are three groups of contributors to Appium that this scheme supports: (1) project
+maintainers (those who devote consistent time to leading the project), (2) project contributors
+(anyone in the wider community that contributes code or documentation), and (3) upstream projects
+(other open source projects Appium relies heavily on to work well). Each month, the funds raised
+via sponsorship will be distributed in different amounts to each of these groups. So if you
+make a valuable contribution to Appium moving forward, you'll be eligible to get some cash as
+a thank-you! (You'll need to have your own OpenCollective account in good standing to receive
+funds).
+
+We're very excited about this new program, and hope that it helps existing and new contributors to
+feel even better about donating their time to making Appium better. And of course, none of this
+would be possible without the amazing Partners and Sponsors we hope to attract! On that note, stay
+tuned over the next few weeks as we unveil some of our initial program launch Partners! And if you
+or your company would like to participate by supporting Appium financially, you are most welcome.
+Just head over to our OpenCollective page and choose the tier that reflects your desired
+contribution level.

packages/appium/docs/en/blog/posts/hello-world.md

@@ -0,0 +1,15 @@
+---
+authors:
+  - jlipps
+date: 2024-03-07
+---
+
+# Hello World!
+
+This is the first post in the Appium blog. There's not much to see here yet. We're creating this
+space so we can make announcements or post other news, or information about events, that don't
+really fit inside the documentation itself.
+
+<!-- more -->
+
+Stay tuned for more!

packages/appium/docs/en/cli/args.md

@@ -27,23 +27,25 @@ below.
 |`--base-path`|Base path to use as the prefix for all webdriver routes running on the server|string|`""`|`-pa`|
 |`--callback-address`|Callback IP address (default: same as `--address`)|string||`-ca`|
 |`--callback-port`|Callback port (default: same as `--port`) (Value must be between `1` and `65535`)|integer|`4723`|`-cp`|
+|`--config`|Path to an [Appium configuration JSON file](../guides/config.md)|string|||
 |`--debug-log-spacing`|Add exaggerated spacing in logs to help with visual inspection|boolean|`false`||
 |`--default-capabilities`|Set the default desired capabilities, which will be set on each session unless overridden by received capabilities. If a string, a path to a JSON file containing the capabilities, or raw JSON.|object||`-dc`|
 |`--deny-insecure`|Set which insecure features are not allowed to run in this server's sessions. Features are defined on a driver level; see documentation for more details. Features listed here will not be enabled even if also listed in `--allow-insecure`, and even if `--relaxed-security` is enabled. If string, a path to a text file containing policy or a comma-delimited list.|array<string>|`[]`||
 |`--driver`|Driver-specific configuration. Keys should correspond to driver package names|object|||
+|`--drivers-import-chunk-size`|The maximum amount of drivers that could be imported in parallel on server startup|number|`3`||
 |`--keep-alive-timeout`|Number of seconds the Appium server should apply as both the keep-alive timeout and the connection timeout for all requests. Setting this to `0` disables the timeout.|integer|`600`|`-ka`|
 |`--local-timezone`|Use local timezone for timestamps|boolean|`false`||
 |`--log`|Also send log output to this file|string||`-g`|
 |`--log-filters`|One or more log filtering rules|array|||
 |`--log-level`|Log level (console[:file]) (Value must be one of: `info`, `info:debug`, `info:info`, `info:warn`, `info:error`, `warn`, `warn:debug`, `warn:info`, `warn:warn`, `warn:error`, `error`, `error:debug`, `error:info`, `error:warn`, `error:error`, `debug`, `debug:debug`, `debug:info`, `debug:warn`, `debug:error`)|string|`debug`||
+|`--log-format`|Log format (Value must be to one of: `text`, `json`, `pretty_json`). If logs are printed as JSON then the text coloring is always disabled.|string|`text`||
 |`--log-no-colors`|Do not use color in console output|boolean|`false`||
 |`--log-timestamp`|Show timestamps in console output|boolean|`false`||
-|`--plugins-import-chunk-size`|The maximum amount of plugins that could be imported in parallel on server startup|number|`7`||
-|`--drivers-import-chunk-size`|The maximum amount of drivers that could be imported in parallel on server startup|number|`3`||
 |`--long-stacktrace`|Add long stack traces to log entries. Recommended for debugging only.|boolean|`false`||
-|`--no-perms-check`|Skip various permission checks on the server startup if set to true|boolean|`false`||
-|`--nodeconfig`|Path to configuration JSON file to register Appium as a node with Selenium Grid 3; otherwise the configuration itself|object|||
+|`--no-perms-check`|Skip various permission checks on the server startup|boolean|`false`||
+|`--nodeconfig`|Path to configuration JSON file to register Appium as a node with Selenium Grid 3; otherwise the configuration itself|string|||
 |`--plugin`|Plugin-specific configuration. Keys should correspond to plugin package names|object|||
+|`--plugins-import-chunk-size`|The maximum amount of plugins that could be imported in parallel on server startup|number|`7`||
 |`--port`|Port to listen on (Value must be between `1` and `65535`)|integer|`4723`|`-p`|
 |`--relaxed-security`|Disable additional security checks, so it is possible to use some advanced features, provided by drivers supporting this option. Only enable it if all the clients are in the trusted network and it's not the case if a client could potentially break out of the session sandbox. Specific features can be overridden by using `--deny-insecure`|boolean|`false`||
 |`--session-override`|Enables session override (clobbering)|boolean|`false`||
@@ -55,3 +57,13 @@ below.
 |`--use-drivers`|A list of drivers to activate. By default, all installed drivers will be activated.|array<string>|`[]`||
 |`--use-plugins`|A list of plugins to activate. To activate all plugins, the value should be an array with a single item `"all"`.|array<string>|`[]`||
 |`--webhook`|Also send log output to this http listener|string||`-G`|
+
+The following arguments are used for information retrieval, after which the server will automatically exit. They are therefore meant for reference or debug purposes.
+
+|<div style="width:10em">Argument</div>|Description|Alias|
+|--|--|--|
+|`--help`|Print instructions on using the Appium command-line. This argument can also be used for any Appium subcommands.|`-h`|
+|`--show-build-info`|Print detailed information on the Appium server version||
+|`--show-config`|Print the current Appium server configuration details||
+|`--show-debug-info`|Print information on the current environment: details about the operating system, Node.js, and Appium itself||
+|`--version`|Print the Appium server version|`-v`|

packages/appium/docs/en/cli/env-vars.md

@@ -19,3 +19,8 @@ environment variables that the Appium server understands:
 |`APPIUM_PORT`|Same as the `--port` CLI arg|
 |`APPIUM_RELOAD_EXTENSIONS`|Set to `1` to cause Appium to re-require extensions when new sessions are created. This is mostly useful for [building extensions](../developing/build-drivers.md)|
 |`APPIUM_OMIT_PEER_DEPS`|Adds `--omit=peer` to all the NPM commands run internally by Appium. Mostly an internal feature.|
+|`APPIUM_APPS_CACHE_MAX_AGE`|Allows to set the maximum age (in minutes) for [cached applications](../guides/caching.md). The default value is `60 * 24` (24 hours). Do not set it to a lower number than the duration of a single session startup.|
+|`APPIUM_APPS_CACHE_MAX_ITEMS`|Allows to set the maximum amount of [cached applications](../guides/caching.md). The default value is `1024`. Do not set it to a lower number than the amount of apps in all parallel sessions per process.|
+|`APPIUM_APPS_CACHE_IGNORE_URL_QUERY`| If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys. See the corresponding
+[feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713)
+for more details. Disabled by default.|

packages/appium/docs/en/cli/extensions.md

@@ -30,28 +30,34 @@ All Extension CLI commands can take an optional `--json` argument, which will re
 the command as a machine-readable JSON string rather than the standard output, which is colourized
 and tuned for human consumption.
 
-### `list`
+### `doctor`
 
-List installed and available extensions. "Available" extensions include those which are officially
-recognized by the Appium team, but you are not limited to installing only the extensions displayed
-in this list.
+Run doctor checks for the given extension, which validate whether the extension has its prerequisites
+configured correctly. Note that not all extensions include doctor checks. See the
+[Building Doctor Checks](../developing/build-doctor-checks.md) tutorial for more details on
+how to create them.
 
 Usage:
 
 ```
-appium <ext-type> list [--installed] [--updates] [--json]
+appium <ext-type> doctor <ext-name>
 ```
 
 Required arguments:
 
 - `<ext-type>`: must be `driver` or `plugin`
+- `<ext-name>`: the name of the extension whose doctor checks you want to run
 
 Optional arguments:
 
-- `--installed`: show only installed extensions, not installed plus available extensions
-- `--updates`: for extensions installed via NPM, display a message if there are any updates
 - `--json`: return the result in JSON format
 
+Example (run doctor checks for the UiAutomator2 driver):
+
+```
+appium driver doctor uiautomator2
+```
+
 ### `install`
 
 Install an extension. If successful, respond with the short name of the extension which can be used
@@ -124,46 +130,26 @@ by `npm install`:
     appium plugin install --source=local /path/to/my/plugin
     ```
 
-### `update`
+### `list`
 
-Update one or more extensions that have been installed via NPM. By default, Appium will not
-automatically update any extension that has a revision in its major version, so as to prevent
-unintended breaking changes.
+List installed and available extensions. "Available" extensions include those which are officially
+recognized by the Appium team, but you are not limited to installing only the extensions displayed
+in this list.
 
 Usage:
 
 ```
-appium <ext-type> update <ext-name> [--unsafe] [--json]
+appium <ext-type> list [--installed] [--updates] [--json]
 ```
 
 Required arguments:
 
 - `<ext-type>`: must be `driver` or `plugin`
-- `<ext-name>`: the name of the extension to update, or the string `installed` (which will update
-  all installed extensions)
-
-Optional arguments:
-
-- `--unsafe`: direct Appium to go ahead and update passed a major version boundary
-- `--json`: return the result in JSON format
-
-### `uninstall`
-
-Remove an installed extension.
-
-Usage:
-
-```
-appium <ext-type> uninstall <ext-name> [--json]
-```
-
-Required arguments:
-
-- `<ext-type>`: must be `driver` or `plugin`
-- `<ext-name>`: the name of the extension to uninstall
 
 Optional arguments:
 
+- `--installed`: show only installed extensions, not installed plus available extensions
+- `--updates`: for extensions installed via NPM, display a message if there are any updates
 - `--json`: return the result in JSON format
 
 ### `run`
@@ -187,7 +173,7 @@ Required arguments:
 
 Optional arguments:
 
-* `script-args`: any arguments that Appium does not interpret as belonging to its own set of
+- `script-args`: any arguments that Appium does not interpret as belonging to its own set of
   arguments will be passed along to the extension script
 - `--json`: return the result in JSON format
 
@@ -197,23 +183,44 @@ Example (run the `reset` script included with the UiAutomator2 driver):
 appium driver run uiautomator2 reset
 ```
 
-### `doctor`
+### `update`
 
-Run doctor checks for the given extension if it has any. Extension authors can include
-runnable scripts that assist with driver or plugin preconditions validations. These scripts
-must be valid Node.js sources, must be listed in the package manifest, and must export
-class instances that comply to the particular requirements.
-See the [Building Doctor Checks](../developing/build-doctor-checks.md) tutorial for more
-details on these requirements.
+Update one or more extensions that have been installed via NPM. By default, Appium will not
+automatically update any extension past a major version boundary, so as to prevent
+unintended breaking changes.
 
 Usage:
 
 ```
-appium <ext-type> doctor <ext-name>
+appium <ext-type> update <ext-name> [--unsafe] [--json]
 ```
 
-Example (run doctor checks for the UiAutomator2 driver):
+Required arguments:
+
+- `<ext-type>`: must be `driver` or `plugin`
+- `<ext-name>`: the name of the extension to update, or the string `installed` (which will update
+  all installed extensions)
+
+Optional arguments:
+
+- `--unsafe`: direct Appium to go ahead and update past a major version boundary
+- `--json`: return the result in JSON format
+
+### `uninstall`
+
+Remove an installed extension.
+
+Usage:
 
 ```
-appium driver doctor uiautomator2
+appium <ext-type> uninstall <ext-name> [--json]
 ```
+
+Required arguments:
+
+- `<ext-type>`: must be `driver` or `plugin`
+- `<ext-name>`: the name of the extension to uninstall
+
+Optional arguments:
+
+- `--json`: return the result in JSON format

packages/appium/docs/en/cli/index.md

@@ -11,14 +11,16 @@ the Appium server. This section of the Appium documentation describes how to use
 To start off, you can run `appium -v` or `appium --version` to return the installed version, 
 or run `appium -h` or `appium --help` to return the help message.
 
-The main `appium` executable provides 3 subcommands:
+The main `appium` executable provides the following subcommands:
 
 1. `appium server` (or simply `appium`) - launch an Appium server
     - [See here for accepted arguments](./args.md)
     - For advanced features, [see here for accepted environment variables](./env-vars.md)
 2. `appium driver` - manage Appium drivers
-    - [See here for accepted arguments](./extensions.md)
+    - [See here for details](./extensions.md)
 3. `appium plugin` - manage Appium plugins
-    - [See here for accepted arguments](./extensions.md)
+    - [See here for details](./extensions.md)
+4. `appium setup` - batch install a preset of drivers and plugins
+    - [See here for details](./setup.md)
 
 Like the main command, you can also run each subcommand with the `-h` or `--help` flag to learn more about it.

packages/appium/docs/en/cli/setup.md

@@ -0,0 +1,28 @@
+---
+hide:
+  - toc
+
+title: Setup Command-Line Usage
+---
+
+The `setup` command aims to simplify the initial procedure of setting up Appium. It allows to install
+multiple extensions (drivers/plugins) in one go, without the need to run
+`appium <ext-name> install <ext-name>` multiple times.
+
+The command has several presets that can be used to install different sets of extensions.
+The presets are as follows:
+
+|Preset|Installation Command|Included Drivers|Included Plugins|
+|--|--|--|--|
+|Mobile|`appium setup mobile` or `appium setup`|`uiautomator2`, `xcuitest`[^1], `espresso`|`images`|
+|Desktop application|`appium setup desktop`|`mac2`[^1], `windows`[^2]|`images`|
+|Desktop browser|`appium setup browser`|`safari`[^1], `gecko`, `chromium`|`images`|
+
+Attempting to install a preset while already having one or more of its included extensions installed
+will only install the missing extensions.
+
+Refer to the [Ecosystem documentation](../ecosystem/index.md) to learn more about the extensions
+listed above.
+
+[^1]: Only installed if the host machine is running macOS.
+[^2]: Only installed if the host machine is running Windows.

packages/appium/docs/en/commands/base-driver.md

@@ -217,6 +217,10 @@ A possibly empty list of elements inside the shadow root matching the selector
 
 Get the log for a given log type.
 
+!!! warning "Deprecated"
+
+    Please use the `/session/:sessionId/se/log` endpoint instead
+
 <!-- comment source: method-signature -->
 
 #### Parameters
@@ -273,6 +277,10 @@ The event history for the session
 
 Get available log types as a list of strings
 
+!!! warning "Deprecated"
+
+    Please use the `/session/:sessionId/se/log/types` endpoint instead
+
 <!-- comment source: method-signature -->
 
 #### Response
@@ -319,9 +327,22 @@ Get data for all sessions running on an Appium server
 
 #### Response
 
-`MultiSessionData`<`C`\>[]
+A list of session data objects.
+Each session data object will be returned with `id` and the session's capabilities as `capabilities` keys like an example below:
 
-A list of session data objects
+```json
+[
+  {
+    "id":"ba30c6da-c266-4734-8ddb-c16f5bb53e16",
+    "capabilities":{ "platformName":"ios","browserName":"safari","automationName":"xcuitest","platformVersion":"17.2","deviceName":"iPhone 15" }
+  },
+  {
+    "id":"1441110c-1ece-4e45-abbf-ebf404f45f0a",
+    "capabilities":{ "platformName":"ios","browserName":"safari","automationName":"xcuitest","platformVersion":"17.0","deviceName":"iPhone 14" }
+  },
+  ...
+]
+```
 
 ### `getSettings`
 
@@ -465,7 +486,9 @@ Set the various timeouts associated with a session
 
 Set the implicit wait timeout
 
-**`Deprecated`**
+!!! warning "Deprecated"
+
+    Please use the `/session/:sessionId/timeouts` endpoint instead
 
 Use `timeouts` instead
 
@@ -506,7 +529,9 @@ Add a custom-named event to the Appium event log
 
 Reset the current session (run the delete session and create session subroutines)
 
-**`Deprecated`**
+!!! warning "Deprecated"
+
+    Please use each driver's launch, activate, terminate or cleanup method.
 
 Use explicit session management commands instead
 

packages/appium/docs/en/developing/build-drivers.md

@@ -58,20 +58,20 @@ work with certain versions of Appium). For Appium 2, for example, this would loo
 Your `package.json` must contain an `appium` field, like this (we call this the 'Appium extension
 metadata'):
 
-    ```json
-    {
-      ...,
-      "appium": {
-        "driverName": "fake",
-        "automationName": "Fake",
-        "platformNames": [
-          "Fake"
-        ],
-        "mainClass": "FakeDriver"
-      },
-      ...
-    }
-    ```
+```json
+{
+  ...,
+  "appium": {
+    "driverName": "fake",
+    "automationName": "Fake",
+    "platformNames": [
+      "Fake"
+    ],
+    "mainClass": "FakeDriver"
+  },
+  ...
+}
+```
 
 The required subfields are:
 
@@ -130,12 +130,12 @@ like this:
 
 ```json
 {
-    "devDependencies": {
-        ...,
-        "appium": "^2.0.0",
-        "your-driver": "file:.",
-        ...
-    }
+  "devDependencies": {
+    ...,
+    "appium": "^2.0.0",
+    "your-driver": "file:.",
+    ...
+  }
 }
 ```
 
@@ -657,6 +657,13 @@ A couple notes about this system:
 1. The `executeMethod` helper will reject with an error if a script name doesn't match one of the
    script names defined as a command in `executeMethodMap`, or if there are missing parameters.
 
+
+### Build Appium Doctor checks
+
+Your users can run `appium driver doctor <driverName>` to run installation and health checks. Visit
+the [Building Doctor Checks](./build-doctor-checks.md) guide for more information on this
+capability.
+
 ### Implement handling of Appium settings
 
 Appium users can send parameters to your driver via CLI args as well as via capabilities. But these

packages/appium/docs/en/developing/build-plugins.md

@@ -412,6 +412,12 @@ Overriding Execute Methods from drivers works as you'd expect: if your plugin de
 Method with the same name as that of a driver, your command (in this case `plugMeIn`) will be
 called first. You can choose to run the driver's original behaviour via `next` if you want.
 
+### Build Appium Doctor checks
+
+Your users can run `appium plugin doctor <pluginName>` to run installation and health checks. Visit
+the [Building Doctor Checks](./build-doctor-checks.md) guide for more information on this
+capability.
+
 ### Update the Appium server object
 
 You probably don't normally need to update the Appium server object (which is an

packages/appium/docs/en/ecosystem/clients.md

@@ -31,6 +31,7 @@ These clients are not maintained by the Appium team and can be used with other l
 |[WebdriverIO](https://webdriver.io/docs/appium)|Node.js|
 |[Nightwatch.js](https://nightwatchjs.org/guide/mobile-app-testing/introduction.html)|Node.js|
 |[RobotFramework](https://github.com/serhatbolsu/robotframework-appiumlibrary)|DSL|
+|[multicatch's appium-client](https://github.com/multicatch/appium-client)|Rust|
 
 In general, any W3C WebDriver spec-compatible client will also integrate well with Appium, though
 some Appium-specific commands may not be implemented in other clients.

packages/appium/docs/en/ecosystem/drivers.md

@@ -27,6 +27,7 @@ These drivers are currently maintained by the Appium team:
 |[Mac2](https://github.com/appium/appium-mac2-driver)|`mac2`|macOS|Native|
 |[Safari](https://github.com/appium/appium-safari-driver)|`safari`|macOS, iOS|Web|
 |[UiAutomator2](https://github.com/appium/appium-uiautomator2-driver)|`uiautomator2`|Android|Native, Hybrid, Web|
+|[Windows](https://github.com/appium/appium-windows-driver)|`windows`|Windows|Native|
 |[XCUITest](https://github.com/appium/appium-xcuitest-driver)|`xcuitest`|iOS|Native, Hybrid, Web|
 
 ### Other Drivers
@@ -41,7 +42,6 @@ These drivers are not maintained by the Appium team and can be used to target ad
 |[Roku](https://github.com/headspinio/appium-roku-driver)|`--source=npm @headspinio/appium-roku-driver`|Roku|Native|HeadSpin|
 |[Tizen](https://github.com/Samsung/appium-tizen-driver)|`--source=npm appium-tizen-driver`|Android|Native|Community / Samsung|
 |[TizenTV](https://github.com/headspinio/appium-tizen-tv-driver)|`--source=npm appium-tizen-tv-driver`|Samsung TV|Web|HeadSpin|
-|[Windows](https://github.com/appium/appium-windows-driver)|`--source=npm appium-windows-driver`|Windows|Native|Community / Microsoft|
 |[Youi](https://github.com/YOU-i-Labs/appium-youiengine-driver)|`--source=npm appium-youiengine-driver`|iOS, Android, macOS, Linux, tvOS|Native|Community / You.i|
 
 !!! note

packages/appium/docs/en/ecosystem/tools.md

@@ -8,7 +8,7 @@ title: Appium-Related Tools
 There are several Appium tools that have been created to to assist with things not directly related
 to testing, such as Appium installation, test development, and more.
 
-### Appium Inspector
+### [Appium Inspector](https://appium.github.io/appium-inspector/latest/)
 
 Appium has a graphical client which can be used to inspect application screenshots, view the
 application hierarchy, run Appium commands, record app interactions, and more. It is very useful
@@ -18,14 +18,20 @@ Find downloads and more information on its GitHub page: [Appium Inspector](https
 
 ### Appium Doctor
 
-The `appium-doctor` CLI tool can be used to validate proper environment setup for Android and iOS
-automation, and identify any common configuration issues. It can be installed with `npm`:
+Appium Doctor is a command-line tool built into Appium drivers and plugins.
+The command is expected to be used to validate whether a driver or plugin has all of its prerequisites and other environment details set up correctly
+if the driver/plugin author implemented the `doctor` command.
 
-```sh
-npm install -g @appium/doctor
+For example, `uiautomator2` driver provides the `doctor` command below.
+
+```
+appium driver doctor uiautomator2
 ```
 
-Learn more on its GitHub page: [Appium Doctor](https://github.com/appium/appium/tree/master/packages/doctor)
+It shows no result if the driver/plugin author did not implement them.
+
+More information on this command can be found in the [Command-Line Usage documentation](../cli/extensions.md#doctor).
+For driver/plugin developers, please read [Building Doctor Checks](../developing/build-doctor-checks.md).
 
 ### Other Tools
 

packages/appium/docs/en/guides/branch-testing.md

@@ -0,0 +1,57 @@
+---
+title: Local Validation Of Extension PRs
+---
+
+Sometimes it might be necessary to validate if a remote driver or a plugin PR works for the particular local
+environment before it is merged or published. This tutorial describes how to achieve that.
+
+## Requirements
+
+- Recent LTS version of NodeJS. Check [Node.js main page](https://nodejs.org) for the download link.
+- Recent version of the Appium server. Use the following commands to ensure you have
+  the latest version installed: `npm uninstall appium` and `npm install -g appium`.
+- [Git](https://git-scm.com/) should be available locally.
+
+## Installation
+
+- [Check out]((https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)) the PR locally.
+  There is also an option (although it is less flexible, because you won't be able to easily fetch
+  any changes to this PR later) to simply [download](https://docs.github.com/en/repositories/working-with-files/using-files/downloading-source-code-archives) and unzip the sources
+  locally. If you choose the later option then no `git` tool would be necessary.
+- Navigate to the local driver or plugin folder and run `npm i` from that folder.
+- Make sure you don't have the given driver or plugin already installed. Use the `appium driver uninstall <driver_name>`
+  or `appium plugin uninstall <plugin_name>` CLI in order to delete any leftovers. The value of
+  `<driver_name>`/`<plugin_name>` depends on the actual driver or plugin name the PR has been prepared for.
+  If you are not sure which name you need to use then check the content of the `package.json` manifest,
+  which must be always located under the root folder of the fetched sources. You should be looking for
+  the `"appium" -> "driverName"` entry value there.
+- Change the current folder to the one, which is NOT the driver/plugin folder root or its subfolder.
+  Also, make sure your current working folder does not contain any extra `package.json` file. If
+  it does then simply navigate to any other folder that does not.
+- Run the following command in order to link the driver/plugin sources to the Appium server:
+  `appium driver install --source=local <full_path_to_driver_folder_with_fetched_sources>` or
+  `appium plugin install --source=local <full_path_to_plugin_folder_with_fetched_sources>`.
+- Stop the Appium server if it is running and start it again (`appium server --use-drivers=<driver_name>`)
+  to check the list of loaded drivers. If the linking succeeded then you must see the driver name and the path to its
+  parent folder in the server logs. In case of a plugin it is required to explicitly request
+  this plugin to be loaded upon server startup: `appium server --use-plugins=<plugin_name>`.
+
+## Update
+
+After you have tested the PR and there are issues it might be necessary to update the local branch with
+the recent changes from Git. Follow the next steps for that:
+
+- Navigate to the parent folder of your local driver/plugin and run `git pull`.
+- Stop Appium server if it is running.
+- Run `npm i` in the parent folder of your local driver/plugin to rebuild it and update any dependencies if necessary.
+- Start Appium server again similarly to how this is done in the corresponding [Installation](#installation) step above.
+
+## Switching Back To a Stable Release
+
+After the PR is merged there is no need to use the local plugin/driver deployment anymore, and it makes sense
+to switch back to the package managed by NPM. Follow the next steps for that:
+
+- Unlink the installed driver/plugin from the server by running `appium driver uninstall <driver_name>` or
+  `appium plugin uninstall <driver_name>`.
+- Delete the local source folder (`rm -rf <full_path_to_plugin_or_driver_folder_with_fetched_sources>`).
+- Install the driver or the plugin from NPM. Check the component README in order to find a proper command for that.

packages/appium/docs/en/guides/caching.md

@@ -16,7 +16,8 @@ bundle for each test.
 
 Caching could be applied to application bundles generated by
 [`configureApp`](https://github.com/appium/appium/blob/master/packages/base-driver/lib/basedriver/helpers.js#L107) helper call.
-Inherited drivers can customize their caching logic by providing own `onPostProcess` property definition, but the general
+Inherited drivers can customize their caching logic by providing own `onPostProcess`
+(or both `inDownload` and `onPostProcess`) property definition, but the general
 rule of thumb is that we need to cache locally all application bundles need to be downloaded and/or extracted
 first before they could be actually installed on the device under test. On iOS, for example, these are `.ipa` or
 `.zip` compressed application bundles, or .`aab` on Android.
@@ -26,18 +27,17 @@ first before they could be actually installed on the device under test. On iOS,
 In order to validate whether an app bundle downloaded from the given URL could be (re)used from the cache the following
 steps are applied:
 
-1. The script is sending `HEAD` request to the given link in order to only fetch response headers. If this request fails/
-times out then no caching is applied.
-2. The following header values are being extracted: `Last-Modified`, `Cache-Control`. If no `Last-Modified` header is present
-or the header value cannot be parsed as a valid datetime then no caching is applied.
-3. The script checks if the given URL is already present in the cache. If the app is not cached yet then it gets downloaded
-and its current header values along with hashsum are added to the cache.
-4. If the URL was already in the cache then the script verifies that:
-    - the current `Last-Modified` datetime is not different from the previous one
-    - the difference between the current `Last-Modified` datetime and the cached one is not greater than max-age (if present)
-    - the hashsum of the cached file/folder is not changed (e.g. it was not corrupted while sitting in the cache)
-5. If all validations above succeed then the cached build is returned, otherwise the currently cached entry gets
-deleted and a new one is downloaded instead.
+1. The script checks if the given URL is already present in the cache.
+   If yes then it tries to fetch previously remembered
+   [Last-Modified](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified)
+   or [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header values for it.
+2. If `ETag` value is present then it is put into
+   [If-None-Match request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match).
+   Else if `Last-Modified` header value is present then it is put into
+   [If-Modified-Since request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since).
+   Otherwise, no caching is applied.
+3. If the response status is equal to `304` then the previously cached binary is used,
+   otherwise the cached entry is reset and refreshed.
 
 ## Caching of Local Application Bundles
 
@@ -55,9 +55,19 @@ The cache where the base driver keeps all application bundles is located in the
 on per-process basis, so each test session initialized in scope of the same Appium server process takes advantages
 of it. It is a [LRU Cache](https://www.npmjs.com/package/lru-cache) with the following limitations:
 
-- Max items: 1024
-- Max time to live (TTL) for each entry: 24 hours
+- Max items: 1024. You may customize it by providing a new value to
+  the [APPIUM_APPS_CACHE_MAX_ITEMS](../cli/env-vars.md) environment variable.
+  Do not set it to a lower number than the amount of apps in all parallel sessions per process.
+- Max time to live (TTL) for each entry: 24 hours.
+  You may customize it by providing a new value to the
+  [APPIUM_APPS_CACHE_MAX_AGE](../cli/env-vars.md) environment variable.
+  Do not set it to a lower number than the duration of a single session startup.
 - TTL is refreshed for each entry upon access
+- By default the full application URL is used as cache key. You may change this behavior
+  by enabling the [APPIUM_APPS_CACHE_IGNORE_URL_QUERY](../cli/env-vars.md) environment variable.
+  If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys.
+  See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713)
+  for more details.
 
 !!! warning
 

packages/appium/docs/en/index.md

@@ -6,7 +6,8 @@ hide:
 title: Welcome
 ---
 <style>
-  .md-typeset h1 {
+  .md-typeset h1,
+  .appium-sponsor-thanks {
     display: none;
   }
 </style>
@@ -19,6 +20,31 @@ software, designed to facilitate UI automation of many app platforms, including
 Android, Tizen), browser (Chrome, Firefox, Safari), desktop (macOS, Windows), TV (Roku, tvOS,
 Android TV, Samsung), and more!
 
+
+<div style="text-align: center; margin-top: 2rem; font-style: italic;">
+  Appium is extremely grateful for the support of its key partners! (Learn more about our
+  sponsorship program and contributor compensation scheme <a
+  href="https://github.com/appium/appium/blob/master/GOVERNANCE.md#sponsorship">here</a>)
+  <div class="homepageSponsors">
+    <div class="homepageSponsor">
+      <a href="https://www.headspin.io/solutions/appium-mobile-test-automation">
+        <img src="assets/images/sponsor-logo-headspin.png" style="width: 200px;" />
+      </a>
+    </div>
+    <div class="homepageSponsor">
+      <a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+        <img src="assets/images/sponsor-logo-browserstack-dark.png#only-dark" style="width: 220px;" />
+        <img src="assets/images/sponsor-logo-browserstack-light.png#only-light" style="width: 220px;" />
+      </a>
+    </div>
+    <div class="homepageSponsor">
+      <a href="https://saucelabs.com/resources/blog/appium-strategic-partner">
+        <img src="assets/images/sponsor-logo-sauce.png" style="width: 200px;" />
+      </a>
+    </div>
+  </div>
+</div>
+
 ## Explore the Documentation
 
 <div class="grid cards" markdown>

packages/appium/docs/en/intro/drivers.md

@@ -32,7 +32,7 @@ driver install`.
 So, from a technical perspective, an Appium driver is just a bit of code that inherits from some
 other Appium code. That's it! Now, inheriting from `BaseDriver` actually gives us a lot, because
 `BaseDriver` is essentially an encapsulation of the entire WebDriver protocol. So all a driver
-needs to do to do something useful is to *implement* Node.js methods with names corresponding to
+needs to do something useful is to *implement* Node.js methods with names corresponding to
 their WebDriver protocol equivalents.
 
 So let's say I wanted to do something with this empty driver; first I have to decide which

packages/appium/docs/en/quickstart/index.md

@@ -12,10 +12,10 @@ running Appium and writing Appium scripts.
 The basic plan for this quickstart is as follows:
 
 1. Install Appium
-1. Install an Appium driver and its dependencies (we'll be using the [UiAutomator2
-driver](https://github.com/appium/appium-uiautomator2-driver) for these examples)
-1. Install an Appium client library in your language of choice (this guide contains options for
-JavaScript, Python, Java, Ruby, and .NET).
+1. Install an Appium driver and its dependencies
+    - This guide provides instructions for the [UiAutomator2 driver](https://github.com/appium/appium-uiautomator2-driver)
+1. Install an Appium client library in your language of choice
+    - This guide contains options for JavaScript, Python, Java, Ruby, and .NET
 1. Write and run a simple Appium automation script using a sample application
 
 ### Requirements

packages/appium/docs/en/quickstart/install.md

@@ -9,27 +9,42 @@ title: Install Appium
 
     Before installing, make sure to check the [System Requirements](./requirements.md).
 
-You can install Appium globally using `npm`:
+Appium can be installed globally using `npm`:
 
 ```bash
-npm i -g appium
+npm install -g appium
 ```
 
 !!! note
 
     Other package managers are not currently supported.
 
-After installation, you should be able to run Appium from the command line:
+## Starting Appium
+
+Appium can be started [using the command line](../cli/index.md):
 
 ```
 appium
 ```
 
-You should see some output that starts with a line like this:
+This launches the Appium server process, which loads all the installed Appium drivers, and
+begins waiting for new session requests from client connections (such as test automation scripts).
+Since the server process is independent from its clients, it must be explicitly launched before
+attempting to start a new session.
+
+When the server is launched, the console log will list all the valid URLs that clients can use to
+connect to this server:
 
 ```
-[Appium] Welcome to Appium v2.0.0
+[Appium] You can provide the following URLs in your client code to connect to this server:
+[Appium] 	http://127.0.0.1:4723/ (only accessible from the same host)
+(... any other URLs ...)
 ```
 
-That's it! If you see this, the Appium server is up and running. Go ahead and quit
-it (Ctrl-C) and move on to the [next step](./uiauto2-driver.md), where we'll install a driver for automating Android apps.
+Once a client requests a new session, the Appium server process will start logging all details about
+this session until its termination. Keep this in mind - if you ever encounter issues with Appium
+tests, you can always check the server log for more details.
+
+So what's next? Even though Appium is installed and running, it does not come bundled with any
+drivers, which means it cannot automate anything yet. We will therefore set up automation for
+Android - continue to [Installing the UiAutomator2 Driver](./uiauto2-driver.md).

packages/appium/docs/en/quickstart/requirements.md

@@ -9,6 +9,7 @@ The basic requirements for the Appium server are:
 
 * A macOS, Linux, or Windows operating system
 * [Node.js](https://nodejs.org) version in the [SemVer](https://semver.org) range `^14.17.0 || ^16.13.0 || >=18.0.0`
+    * LTS is recommended
 * [`npm`](https://npmjs.com) version `>=8` (`npm` is usually bundled with Node.js, but can be upgraded
 independently)
 
@@ -23,6 +24,6 @@ documentation of the [Appium driver(s)](../ecosystem/drivers.md) for that platfo
 dependencies. It is almost universally the case that Appium drivers for a given platform will
 require the developer toolchain and SDKs for that platform to be installed.
 
-You may find it useful to use the `appium-doctor` tool for verifying if all driver requirements are
-installed. It can check the prerequisites for Android and iOS drivers.
-Learn more on its GitHub page: [Appium Doctor](https://github.com/appium/appium/tree/master/packages/doctor)
+In order to assist with driver requirements, each (official) driver comes with the Appium Doctor tool,
+which allows to verify if all requirements have been set up. Learn more about how to use this tool in
+the [Command-Line Usage documentation](../cli/extensions.md#doctor).

packages/appium/docs/en/quickstart/test-js.md

@@ -47,6 +47,11 @@ contents:
     [WebdriverIO documentation](https://webdriver.io/docs/gettingstarted) for a fuller explanation
     of the various API commands you see and what their purpose is.
 
+!!! note
+
+    The sample code is available from [GitHub Appium repository](https://github.com/appium/appium/tree/master/packages/appium/sample-code/quickstarts/js).
+
+
 Basically, this code is doing the following:
 
 1. Defining a set of "Capabilities" (parameters) to send to the Appium server so Appium knows what
@@ -68,4 +73,3 @@ If all goes well, you'll see the Settings app open up and navigate to the "Batte
 app closes again.
 
 Congratulations, you've started your Appium journey! Read on for some [next steps](./next-steps.md) to explore.
-

packages/appium/docs/en/quickstart/test-py.md

@@ -26,11 +26,17 @@ You usually do not need to worry about the prefix.
 
     It's not within the scope of this guide to give a complete run-down on the Python client
     library or everything that's happening here, so we'll leave the code itself unexplained in detail for now.
+
     - You may want to read up particularly on Appium [Capabilities](../guides/caps.md).
     - [functional test code](https://github.com/appium/python-client/tree/master/test/functional) in Python Client GitHub repository should help to find more working example.
     - [Documentation](https://appium.github.io/python-client-sphinx/) also helps to find methods
     defined in the Appium Python Client.
 
+!!! note
+
+    The sample code is available from [GitHub Appium repository](https://github.com/appium/appium/tree/master/packages/appium/sample-code/quickstarts/py).
+
+
 Basically, this code is doing the following:
 
 1. Defining a set of "Capabilities" (parameters) to send to the Appium server so Appium knows what

packages/appium/docs/en/quickstart/test-rb.md

@@ -6,12 +6,32 @@ title: Write a Test (Ruby)
 ---
 
 
-The [AppiumLib](https://github.com/appium/ruby_lib) and the [AppiumLibCore](https://github.com/appium/ruby_lib_core) (**recommended**) are official Appium client libraries in Ruby, which are available via gem under the [appium_lib](https://rubygems.org/gems/appium_lib) and the [appium_lib_core](https://rubygems.org/gems/appium_lib_core) package names. The appium_lib_core inherits from the Selenium Ruby Binding, and the appium_lib inherits from the appium_lib_core, so installing these libraries include the selenium binding. We recommend `appium_lib_core` if you need a less complex client-side solution. The `appium_lib` has some useful methods the core does not have, but for the cost of greater complexity.
+The [AppiumLib](https://github.com/appium/ruby_lib) and the [AppiumLibCore](https://github.com/appium/ruby_lib_core) (**recommended**) are official Appium client libraries in Ruby, which are available via gem under the [appium_lib](https://rubygems.org/gems/appium_lib) and the [appium_lib_core](https://rubygems.org/gems/appium_lib_core) package names. The appium_lib_core inherits from the Selenium Ruby Binding, and the appium_lib inherits from the appium_lib_core, so installing these libraries include the selenium binding. We recommend `appium_lib_core` if you need a less complex client-side solution. The `appium_lib` has some useful methods the core does not have, but for the cost of greater complexity and historical methods which may not work in the latest environment.
+
+As the first step, let's initialize a Gemfile to manage the dependency:
 
 ```bash
-gem install appium_lib
+bundle init
+```
+
+Then, you could add Appium Ruby Client dependency as below:
+
+```bash
+bundle add appium_lib_core
 # or
-gem install appium_lib_core
+# bundle add appium_lib
+```
+
+Test code example below uses `test-unit` module, thus please run:
+
+```bash
+bundle add test-unit
+```
+
+Once these steps has done, your `Gemfile` file should include:
+
+```ruby title="Gemfile"
+--8<-- "./sample-code/quickstarts/rb/Gemfile"
 ```
 
 The `appium_lib_core` is the main part as an Appium client.
@@ -21,7 +41,7 @@ The `appium_lib_core` is the main part as an Appium client.
 This example is by the `appium_lib_core` with `test-unit` gem module.
 Tes code in `appium_lib` should be similar.
 
-```python title="test.py"
+```ruby title="test.rb"
 --8<-- "./sample-code/quickstarts/rb/test.rb"
 ```
 
@@ -34,6 +54,10 @@ Tes code in `appium_lib` should be similar.
     - [functional test code](https://github.com/appium/ruby_lib_core/tree/master/test/functional) in the appium_lib_core GitHub repository should help to find more working example.
     - Documentation [appium_lib_core](https://www.rubydoc.info/github/appium/ruby_lib_core) and [appium_lib](https://www.rubydoc.info/github/appium/ruby_lib) also helps to find available methods.
 
+!!! note
+
+    The sample code is available from [GitHub Appium repository](https://github.com/appium/appium/tree/master/packages/appium/sample-code/quickstarts/rb).
+
 
 Basically, this code is doing the following:
 
@@ -49,7 +73,7 @@ running in another terminal session, otherwise you'll get an error about not bei
 to one. Then, you can execute the script:
 
 ```bash
-bundle install
+# Please run "bundle install" first if your environment has not run the installation command yet.
 bundle exec ruby test.rb
 ```
 

packages/appium/docs/en/quickstart/uiauto2-driver.md

@@ -60,8 +60,14 @@ set up on your system, so you can get busy making Android apps if you want!
 
 ## Install the driver itself
 
-Since the UiAutomator2 driver is maintained by the core Appium team, it has an 'official' driver
-name that you can use to install it easily via the [Appium Extension CLI](../cli/extensions.md):
+### Standard Install
+
+Like all Appium drivers, the UiAutomator2 driver is installed via the [Appium Extension CLI](../cli/extensions.md).
+Since UiAutomator2 is maintained by the core Appium team, it has an 'official' driver name
+(`uiautomator2`), which makes the installation simpler.
+
+Before installing, make sure your Appium server is _not_ running (if it is, quit it with _Ctrl-C_).
+Then run the following command:
 
 ```bash
 appium driver install uiautomator2
@@ -77,11 +83,9 @@ Driver uiautomator2@2.0.5 successfully installed
 - platformNames: ["Android"]
 ```
 
-Running this command will locate and install the latest version of the UiAutomator2 driver, making
-it available for automation. Note that when it is installed it tells you what platforms it is valid
-for (in this case, `Android`), and what automation name (the `appium:automationName`
-[capability](../guides/caps.md)) must be used to select this driver for use during an Appium
-session (in this case, `UiAutomator2`).
+Note how the installation process specifies what platforms is the driver valid for (in this case,
+`Android`), and what automation name (the `appium:automationName` [capability](../guides/caps.md))
+must be used to select this driver for use during an Appium session (in this case, `UiAutomator2`).
 
 !!! note
 
@@ -90,6 +94,34 @@ session (in this case, `UiAutomator2`).
     prefer to use `npm` to manage Appium and its connected drivers. To learn more about this
     technique, visit the guide on [managing Appium extensions](../guides/managing-exts.md).
 
+### Batch Install
+
+You may want to use Appium with more than one driver. One way to accomplish this is to run
+`appium driver install <driver-name>` for each individual driver, but you can also install multiple
+drivers in one go:
+
+```
+appium setup
+```
+
+Running this will install Appium's mobile-specific drivers: UiAutomator2, [XCUITest](https://appium.github.io/appium-xcuitest-driver/)
+(only if running macOS), and [Espresso](https://github.com/appium/appium-espresso-driver).
+
+You can also use this command to batch install drivers for desktop applications or desktop browsers.
+For more details on this, refer to the [Setup command documentation](../cli/setup.md).
+
+### Validating the Install
+
+The UiAutomator2 driver, like all official Appium drivers, comes with the Appium Doctor tool, which
+allows validating whether all prerequisites have been set up correctly:
+
+```
+appium driver doctor uiautomator2
+```
+
+This guide has focused on essential requirements, so Appium Doctor may suggest one or more optional
+fixes. But if you see `0 required fixes needed`, that means everything is set up!
+
 Now, start the Appium server again (run `appium`), and you should see that the newly-installed
 driver is listed as available:
 

packages/appium/docs/ja/blog/index.md

@@ -0,0 +1,2 @@
+# Blog
+

packages/appium/docs/mkdocs-en.yml

@@ -8,6 +8,7 @@ theme:
   language: en
 nav:
   - Welcome: index.md
+  - Blog: blog/index.md
   - Introduction:
       - intro/index.md
       - Background:
@@ -38,6 +39,7 @@ nav:
       - cli/args.md
       - cli/env-vars.md
       - cli/extensions.md
+      - cli/setup.md
   - Command Reference:
       - commands/index.md
       - commands/base-driver.md
@@ -50,6 +52,7 @@ nav:
           - guides/migrating-1-to-2.md
       - Server/Driver Configuration:
           - guides/managing-exts.md
+          - guides/branch-testing.md
           - guides/config.md
           - guides/security.md
           - guides/log-filters.md
@@ -68,6 +71,7 @@ nav:
       - developing/build-drivers.md
       - developing/build-plugins.md
       - developing/build-docs.md
+      - developing/build-doctor-checks.md
   - Contributing:
       - contributing/index.md
       - contributing/develop.md

packages/appium/docs/mkdocs-zh.yml

@@ -9,12 +9,12 @@ theme:
 nav:
   - 首页: index.md
   - 简介:
-      - 介绍 Appium:
-          - Appium 概述: intro/index.md
+      - intro/index.md
+      - 背景:
+          - intro/appium.md
           - intro/drivers.md
           - intro/clients.md
-      - intro/requirements.md
-      - 历史: intro/history.md
+          - intro/history.md
   - 快速开始:
       - quickstart/index.md
       - quickstart/install.md

packages/appium/docs/overrides/assets/stylesheets/extra.css

@@ -0,0 +1,31 @@
+.md-source__fact--version {
+  display: none;
+}
+.md-source__fact:nth-child(1n + 2):before {
+  margin-left: 0 !important;
+}
+
+.appium-sponsor-thanks {
+  width: 100%;
+  margin: 0.5rem 0.6rem auto 0.6rem;
+  display: flex;
+  align-items: center;
+}
+
+.appium-sponsor-thanks img {
+  margin: auto 6px;
+  height: 40px;
+}
+
+.homepageSponsors {
+  display: flex;
+  flex-direction: row;
+  justify-content: center;
+  align-items: center;
+  margin: 10px auto;
+  max-width: 800px;
+}
+
+.homepageSponsor {
+  flex: 1;
+}

packages/appium/docs/overrides/partials/footer.html

@@ -0,0 +1,79 @@
+<!-- Footer -->
+<footer class="md-footer">
+
+  <!-- Link to previous and/or next page -->
+  {% if "navigation.footer" in features %}
+    {% if page.previous_page or page.next_page %}
+      {% if page.meta and page.meta.hide %}
+        {% set hidden = "hidden" if "footer" in page.meta.hide %}
+      {% endif %}
+      <nav
+        class="md-footer__inner md-grid"
+        aria-label="{{ lang.t('footer') }}"
+        {{ hidden }}
+      >
+
+        <!-- Link to previous page -->
+        {% if page.previous_page %}
+          {% set direction = lang.t("footer.previous") %}
+          <a
+            href="{{ page.previous_page.url | url }}"
+            class="md-footer__link md-footer__link--prev"
+            aria-label="{{ direction }}: {{ page.previous_page.title | e }}"
+          >
+            <div class="md-footer__button md-icon">
+              {% set icon = config.theme.icon.previous or "material/arrow-left" %}
+              {% include ".icons/" ~ icon ~ ".svg" %}
+            </div>
+            <div class="md-footer__title">
+              <span class="md-footer__direction">
+                {{ direction }}
+              </span>
+              <div class="md-ellipsis">
+                {{ page.previous_page.title }}
+              </div>
+            </div>
+          </a>
+        {% endif %}
+
+        <!-- Link to next page -->
+        {% if page.next_page %}
+          {% set direction = lang.t("footer.next") %}
+          <a
+            href="{{ page.next_page.url | url }}"
+            class="md-footer__link md-footer__link--next"
+            aria-label="{{ direction }}: {{ page.next_page.title | e }}"
+          >
+            <div class="md-footer__title">
+              <span class="md-footer__direction">
+                {{ direction }}
+              </span>
+              <div class="md-ellipsis">
+                {{ page.next_page.title }}
+              </div>
+            </div>
+            <div class="md-footer__button md-icon">
+              {% set icon = config.theme.icon.next or "material/arrow-right" %}
+              {% include ".icons/" ~ icon ~ ".svg" %}
+            </div>
+          </a>
+        {% endif %}
+      </nav>
+    {% endif %}
+  {% endif %}
+
+  <!-- Further information -->
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <!-- Sponsor thanks -->
+      {% include "partials/sponsors.html" %}
+
+      {% include "partials/copyright.html" %}
+
+      <!-- Social links -->
+      {% if config.extra.social %}
+        {% include "partials/social.html" %}
+      {% endif %}
+    </div>
+  </div>
+</footer>

packages/appium/docs/overrides/partials/sponsors.html

@@ -0,0 +1,15 @@
+<div class="appium-sponsor-thanks">
+  Supported by
+
+  <a href="https://www.headspin.io/solutions/appium-mobile-test-automation">
+    <img src="/docs/en/latest/assets/images/sponsor-logo-headspin.png" />
+  </a>
+
+  <a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+    <img src="/docs/en/latest/assets/images/sponsor-logo-browserstack-dark.png" />
+  </a>
+
+  <a href="https://saucelabs.com/resources/blog/appium-strategic-partner">
+    <img src="/docs/en/latest/assets/images/sponsor-logo-sauce.png" />
+  </a>
+</div>

packages/appium/docs/scripts/build-docs.js

@@ -20,7 +20,6 @@ const {
   DOCS_REMOTE,
   LATEST_ALIAS,
 } = require('./utils');
-const copyAssets = require('./copy-assets');
 const path = require('path');
 const semver = require('semver');
 const {version} = require('../../package.json');
@@ -35,8 +34,6 @@ const push = Boolean(process.env.APPIUM_DOCS_PUBLISH);
 async function main() {
   log.info(`Building Appium docs and committing to ${DOCS_BRANCH}`);
 
-  await copyAssets();
-
   const semVersion = semver.parse(version);
   if (!semVersion) {
     throw new Error(`Could not parse Appium version "${version}" as semver`);

packages/appium/docs/scripts/copy-assets.js

@@ -1,34 +0,0 @@
-/**
- * This script copies generic assets from `ASSETS_DIR` to each docs language dir.
- */
-
-// @ts-check
-
-// for simplicity this file is not transpiled and is run directly via an npm script
-/* eslint-disable promise/prefer-await-to-callbacks */
-/* eslint-disable promise/prefer-await-to-then */
-
-const {fs} = require('@appium/support');
-const {log, LANGS, DOCS_DIR, ASSETS_DIR} = require('./utils');
-const path = require('path');
-
-async function main() {
-  log.info('Copying generic assets to docs language dirs');
-
-  for (const lang of LANGS) {
-    const langPath = path.join(DOCS_DIR, lang);
-    const langAssetPath = path.join(langPath, 'assets');
-    log.info(`Deleting ${langAssetPath}`);
-    await fs.rimraf(langAssetPath);
-    log.info(`Copying assets into ${langAssetPath}`);
-    await fs.copyFile(ASSETS_DIR, langAssetPath);
-  }
-}
-
-if (require.main === module) {
-  main().catch((err) => {
-    throw err;
-  });
-}
-
-module.exports = main;

packages/appium/docs/zh/blog/index.md

@@ -0,0 +1,2 @@
+# Blog
+

packages/appium/docs/zh/index.md

@@ -1,6 +1,36 @@
 ---
-title: Appium文档
+hide:
+  - navigation
+  - toc
+
+title: 欢迎
 ---
+<style>
+  .md-typeset h1 {
+    display: none;
+  }
+</style>
+<div style="text-align: center">
+  <img src="assets/images/appium-logo-horiz.png" style="max-width: 400px;" />
+</div>
 
+欢迎访问 Appium 文档！Appium 是一个开源项目和相关软件的生态系统。
+软件，旨在促进许多应用程序平台的用户界面自动化，包括移动平台（iOS、
+Android、Tizen）、浏览器（Chrome、Firefox、Safari）、桌面（macOS、Windows）、电视（Roku、tvOS、
+Android TV、三星）等！
 
-TODO
+## 探索文档
+
+<div class="grid cards" markdown>
+
+-   查看 [__介绍__](./intro/index.md) 确保您理解关键概念
+-   通过 [__快速入门__](./quickstart/index.md) 来进行设置并运行基本的 Android 测试
+-   访问 [__生态系统__](./ecosystem/index.md) 页面，查看您可能需要使用的驱动程序、客户端和插件列表
+-   参考 [__CLI 参考__](./cli/index.md) 用于从命令行使用 Appium
+-   查看 [__命令说明__](./commands/index.md) Appium 和插件公开的命令列表
+-   阅读不同的 [__指南__](./guides/migrating-1-to-2.md) 来获取各种说明、技巧和窍门
+-   查阅各种第三方的 [__资源__](./resources.md) 来探索网上的Appium运用
+-   为了创建您自己的Appium拓展, 请查看 [__开发者__](./developing/index.md) 文档
+-   对 Appium 自身的贡献，请查阅 [__贡献__](./contributing/index.md) 页面
+
+</div>

packages/appium/docs/zh/intro/index.md

@@ -1,6 +1,32 @@
 ---
-title: Appium 概述
+hide:
+  - toc
+
+title: Appium in a Nutshell
 ---
+正如主页上提到的那样，Appium旨在支持许多不同平台（移动、网络、桌面等）的UI自动化。不仅如此，它还旨在支持用不同语言（JS、Java、Python等）编写的自动化代码。将所有这些功能结合到一个程序中是一项非常艰巨、甚至不可能的任务！
 
+为了实现这一目标，Appium实际上被分为四个部分：
 
-TODO
+<div class="grid cards" markdown>
+-   :material-image-filter-center-focus-strong: __Appium Core__ - 定义核心API
+-   :material-car: __Drivers__ - 实现与特定平台的连接
+-   :octicons-code-16: __Clients__ - 实现与特定平台的连接
+-   :fontawesome-solid-plug: __Plugins__ - 更改或扩展Appium的核心功能
+</div>
+
+因此，为了开始使用Appium自动化某些内容，您需要：
+- 安装Appium本身
+- 为您的目标平台安装驱动程序
+- 为您的目标编程语言安装客户端库
+- （可选）安装一个或多个插件
+
+这些都是基础！如果您准备好加入，请继续[快速入门](../quickstart/index.md)！
+
+如果您想了解有关其运作方式的更多详细信息，请参阅以下页面了解背景材料：
+
+- [Appium Core](./appium.md)
+- [Appium Drivers](./drivers.md)
+- [Appium Clients](./clients.md)
+
+最后，要了解Appium的起源，请查看[Appium项目历史](./history.md)。

packages/appium/docs/zh/intro/requirements.md

@@ -1,6 +0,0 @@
----
-title: Appium Requirements
----
-
-
-TODO

packages/appium/docs/zh/quickstart/index.md

@@ -1,6 +1,29 @@
 ---
-title: 快速开始
+hide:
+  - toc
+
+title: 快速入门介绍
 ---
 
+让我们开始使用 Appium！为了成功使用本快速入门介绍, 我们建议您
+首先阅读 [介绍](../intro/index.md), 以便您了解
+运行 Appium 和编写 Appium 脚本所涉及的概念。
 
-TODO
+本快速入门课程的基本计划如下:
+
+1. 安装 Appium
+1. 安装 Appium 驱动及其依赖项 (我们将使用 [UiAutomator2
+driver](https://github.com/appium/appium-uiautomator2-driver) 对于这些例子)
+1. 用你选择的语言安装 Appium 客户端库（本指南包含以下选项
+JavaScript、Python、Java、Ruby 和 .NET 的选项）。
+1. 使用示例应用程序编写并运行简单的 Appium 自动化脚本
+
+### 要求
+
+开始之前，请确保您的系统满足运行 Appium 服务器的
+[要求](../quickstart/requirements.md).其他要求
+将在安装 UiAutomator2 驱动程序时一并讨论。 本指南还假设
+您已熟练掌握您的操作系统平台上的基本命令行功能，例如可以运行命令行命令, 设置
+永久的系统变量, 等等...
+
+现在你已经准备好开始了！请前往 [安装 Appium](./install.md)吧.

packages/appium/docs/zh/quickstart/install.md

@@ -1,6 +1,41 @@
 ---
-title: Install Appium
+hide:
+  - toc
+
+title: 安装 Appium
 ---
 
+!!! 信息
 
-TODO
+    安装前，请务必检查[系统要求](./requirements.md).
+
+您可以使用 `npm` 在全局范围内安装 Appium：
+
+```bash
+npm i -g appium
+```
+
+!!! 注意
+
+    目前不支持其他软件包管理器。
+
+安装完成后，您应该可以从命令行运行 Appium：
+
+```
+appium
+```
+
+你应该会看到一些输出结果，开头一行是这样的:
+
+```
+[Appium] 欢迎来到 Appium v2.4.1
+```
+
+为了更新Appiums使用 `npm`:
+
+```bash
+npm update -g appium
+```
+
+就是这样！如果你看到这个，说明 Appium 服务器已经启动并运行。按 (Ctrl-C)
+继续退出并跳转到到  [下一步](./uiauto2-driver.md), 在这里我们将安装一个用于自动运行 Android 应用程序的驱动程序.

packages/appium/docs/zh/quickstart/next-steps.md

@@ -1,6 +1,23 @@
 ---
-title: Next Steps
+hide:
+  - toc
+
+title: 下一步
 ---
 
+既然您已经成功配置了您的系统进行Android自动化并运行了一个简单的测试，
+您可能希望继续探索这份文档。特别是对于初学者，
+以下是一些很好的指南和参考资料：
 
-TODO
+- 在 [生态系统](../ecosystem/index.md) 页面: 浏览可用的驱动程序, 客户端, 插件, 和工具
+- [管理Appium驱动程序与插件](../guides/managing-exts.md)
+- [能力](../guides/caps.md)
+- [设置](../guides/settings.md)
+
+您还会发现[Appium 监测者](https://github.com/appium/appium-inspector) 编写 Appium 测试不可或缺的工具。
+是编写 Appium 测试不可或缺的工具，因为它可以对应用程序进行可视化检查，并
+帮助您发现可用于测试脚本的元素定位器。
+
+您还可以利用为您提供的众多在线 Appium 课程之一。
+
+祝你好运，玩得开心！

packages/appium/docs/zh/quickstart/test-java.md

@@ -1,5 +1,23 @@
 ---
-title: Write a Test (Java)
+hide:
+  - toc
+
+title: 编写一个测试(Java)
 ---
 
-TODO
+Appium 团队为 Java 编程语言维护一个官方[客户端](https://github.com/appium/java-client).
+它是建立在 [Selenium](https://github.com/SeleniumHQ/selenium)上的.
+您也可以在 Kotlin 项目中使用该客户端.
+
+遵循[在测试框架中添加 Appium Java 客户端](https://github.com/appium/java-client#add-appium-java-client-to-your-test-framework)
+教程，以便将该库连接到测试框架源。
+
+Appium Java 客户端有专门的类来支持大多数官方 Appium 驱动程序。对于其他驱动程序
+您只需使用  [AppiumDriver](https://github.com/appium/java-client/blob/master/src/main/java/io/appium/java_client/AppiumDriver.java)类
+或在此基础上创建您的自定义衍生工具. 请查看 [驱动支持](https://github.com/appium/java-client#drivers-support)
+文章，了解有关当前驱动程序类实现的更多信息.
+
+请参阅 [使用实例](https://github.com/appium/java-client#usage-examples) 一文，以了解
+如何从测试框架调用 Java 客户端功能。
+
+成功运行测试后，您可以继续阅读以下内容 [下一步骤](./next-steps.md) 继续探索

packages/appium/docs/zh/quickstart/test-js.md

@@ -1,6 +1,73 @@
 ---
-title: Write a Test (JS)
+hide:
+  - toc
+
+title: 编写一个测试 (JS)
 ---
 
+要在 JavaScript（Node.js）中编写 Appium 测试，我们需要选择一个与 Appium 兼容的客户端
+库。维护最好的库和 Appium 团队推荐使用的库是
+[WebdriverIO](https://webdriver.io), 所有就让我们使用它吧。既然我们已经安装了 Appium，我们
+已经满足了 Node 和 NPM 的要求。因此，只需在计算机上创建一个新的项目目录
+然后在其中初始化一个新的 Node.js 项目:
 
-TODO
+```bash
+npm init
+```
+
+您在提示中输入什么内容并不重要，只要您最终得到一个有效的
+`package.json`.
+
+
+现在，通过 NPM 安装 `webdriverio` 软件包:
+
+```bash
+npm i --save-dev webdriverio
+```
+
+完成上述操作后，您的 `package.json` 文件应包含类似以下内容的部分:
+
+```json title="package.json"
+--8<-- "./sample-code/quickstarts/js/package.json"
+```
+
+现在是编写测试本身的时候了。创建一个名为 `test.js` 的新文件，内容如下:
+
+```js title="test.js"
+--8<-- "./sample-code/quickstarts/js/test.js"
+```
+
+!!! 注意
+
+    本指南的范围不包括完整介绍 WebdriverIO 客户端
+    库或这里发生的一切，因此我们暂且不对代码本身进行详细解释。
+    所以目前我们暂时不对代码本身进行详细解释。您可能需要特别阅读 Appium
+    [能力](../guides/caps.md), 除了熟悉优秀的
+    [WebdriverIO 文档](https://webdriver.io/docs/gettingstarted) 来获得更全面的解释,
+    你还可以看到的各种 API 命令以及用途。
+
+!!! 注意
+
+    示例代码可从 [GitHub Appium repository](https://github.com/appium/appium/tree/master/packages/appium/sample-code/quickstarts/js).
+
+
+基本上，这段代码正在执行以下操作：
+
+1. 定义一组 "Capabilities" 能力值(参数)，以便 Appium 知道您想自动执行哪种任务。
+要自动执行的任务。
+1. 在内置的 Android 设置应用程序上启动 Appium 会话。
+1. 找到 "Battery"列表项并点击它。
+1. 停顿片刻，纯粹是为了观察自动化视觉效果。
+1. 结束 Appium 会话。
+
+就是这样！让我们试一试吧。运行测试前，请确保您的 Appium 服务器
+在另一个终端会话中运行，否则会出现一个有关无法连接到 Appium 服务器的错误。
+然后，你就可以执行脚本了：
+
+```bash
+node test.js
+```
+
+如果一切顺利，在应用再次关闭之前，你会看到 "设置 "应用打开并导航到 "Battery "视图
+
+恭喜您，您已经开始了 Appium 之旅！请继续阅读一些 [下一步骤](./next-steps.md) 继续探索.

packages/appium/docs/zh/quickstart/test-py.md

@@ -1,6 +1,50 @@
 ---
-title: Write a Test (Python)
+hide:
+  - toc
+
+title: 编写一个测试 (Python)
 ---
+[Appium Python Client](https://github.com/appium/python-client) 是官方的Appium Python客户端，可通过pypi里包名为[Appium-Python-Client](https://pypi.org/project/Appium-Python-Client/)进行安装。
+它继承自 [Selenium Python Binding](https://pypi.org/project/selenium/)，
+因此安装Appium Python客户端时会包含selenium绑定。
 
+```bash
+pip install Appium-Python-Client
+```
 
-TODO
+这个示例使用Python内置的`unittest`模块，尽管你可以使用任何你想要的Python测试框架。
+Appium Python客户端自动添加`appium:`供应商前缀。
+通常你不需要担心前缀。
+
+```python title="test.py"
+--8<-- "./sample-code/quickstarts/py/test.py"
+```
+
+!!! note
+
+    在本指南中，我们不会详细解释Python客户端库或这里发生的所有事情，因此现在不对代码本身进行详细说明。
+
+    - 你可能想要特别了解一下Appium [Capabilities](../guides/caps.md)。
+    - Python客户端GitHub仓库中的[功能测试代码](https://github.com/appium/python-client/tree/master/test/functional)应该有助于找到更多的工作示例。
+    - [文档](https://appium.github.io/python-client-sphinx/)也有助于找到在Appium Python客户端中定义的方法。
+
+!!! note
+
+    示例代码可从 [GitHub Appium仓库](https://github.com/appium/appium/tree/master/packages/appium/sample-code/quickstarts/py) 获取。
+
+基本上，这段代码正在做以下事情：
+
+1. 定义一组“Capabilities”（参数），发送到Appium服务器，以便Appium知道你想要自动化的事物类型。
+2. 在内置的 Android 设置应用程序上启动 Appium 会话。
+3. 查找“Battery”列表项并点击它。
+4. 停顿片刻，纯粹是为了观察自动化视觉效果。。
+5. 结束Appium会话。
+
+就这些！让我们试一试。在运行测试之前，请确保你有一个Appium服务器在另一个终端会话中运行，否则你将收到无法连接到服务器的错误。然后，你可以执行脚本：
+
+```bash
+python test.py
+```
+
+如果一切顺利，在应用再次关闭之前，你会看到 "设置 "应用打开并导航到 "Battery "视图。
+恭喜您，您已经开始了您的Appium之旅了！继续阅读一些[下一步骤](./next-steps.md)来探索它吧。

packages/appium/docs/zh/quickstart/uiauto2-driver.md

@@ -1,6 +1,86 @@
 ---
-title: Install the UiAutomator2 Driver
----
 
+title: 安装 UiAutomator2 驱动
 
-TODO
+---
+
+如果没有[驱动](../intro/drivers.md)，你几乎无法使用 Appium，驱动是允许 Appium 自动化特定平台的接口。
+
+!!! info
+
+    在本快速入门指南中，我们将自动化一个 Android 平台的应用，因为通过 Appium 进行 Android 自动化的系统要求与 Appium 本身相同（而 iOS 驱动例如，需要你使用 macOS）。
+
+我们将使用的驱动称为 [UiAutomator2 驱动](https://github.com/appium/appium-uiautomator2-driver)。值得访问该驱动的文档并将其加入书签，因为这将是今后不可或缺的参考资料。
+
+## 设置 Android 自动化要求
+
+根据驱动的要求，除了一个运行中的 Appium 服务器，我们还需要设置以下内容：
+
+### Android SDK
+
+- 设置 Android SDK 要求的最简单方法是下载 [Android Studio](https://developer.android.com/studio)。
+我们需要使用其 SDK 管理器 (_设置 -> 外观和行为 -> 系统设置 -> Android SDK_) 来下载以下项目：
+    - Android SDK 平台（选择我们想要自动化的任何 Android 平台，例如，API 级别 30）
+    - Android SDK 平台工具
+- 如果愿意，你也可以不通过 Android Studio 下载这些项目：
+    - 可以使用 [Android 命令行工具](https://developer.android.com/studio#command-line-tools-only) 中包含的 `sdkmanager` 下载 Android SDK 平台
+    - [Android SDK 平台工具](https://developer.android.com/tools/releases/platform-tools)
+- 设置 `ANDROID_HOME` 环境变量，指向安装 Android SDK 的目录。通常可以在 Android Studio 的 SDK 管理器中找到这个目录的路径。它将包含 `platform-tools` 和其他目录。
+
+### Java JDK
+
+- 安装 Java JDK（对于最新的 Android API 级别，需要 JDK 9，否则需要 JDK 8）。你可以从 [Oracle](https://jdk.java.net/) 或 [Adoptium](https://adoptium.net/en-GB/temurin/releases/) 下载。
+确保下载的是 JDK 而不是 JRE。
+- 设置 `JAVA_HOME` 环境变量，指向 JDK 的安装目录。它将包含 `bin`、`include` 和其他目录。
+
+### 准备设备
+
+- 如果使用模拟器，使用 Android Studio 创建并启动一个 Android 虚拟设备 (AVD)。
+你可能需要下载你想要创建的模拟器的 API 级别的系统镜像。使用 Android Studio 中的 AVD 创建向导通常是完成所有这些操作的最简单方式。
+- 如果使用真实设备，应该[为开发设置并启用 USB 调试](https://developer.android.com/studio/debug/dev-options)。
+- 连接模拟器或设备后，你可以运行 `adb devices`（通过位于 `$ANDROID_HOME/platform-tools/adb` 的二进制文件）来验证你的设备是否显示为已连接。
+
+一旦你的设备在 `adb` 中显示为已连接，并且你已验证环境变量设置正确，你就可以开始了！如果在这些步骤中遇到任何问题，请参考驱动文档，或必要时查看各种 Android 或 Java 文档网站。
+
+此外，恭喜你：不管你是否打算，你现在已经在你的系统上设置了 Android 开发者工具链，所以你可以开始制作 Android 应用了！
+
+## 安装驱动本身
+
+由于 UiAutomator2 驱动是由核心 Appium 团队维护的，它有一个官方的驱动名称，你可以通过 [Appium 扩展 CLI](../cli/extensions.md) 轻松安装：
+
+```bash
+appium driver install uiautomator2
+```
+
+它应该产生类似下面的输出：
+
+```
+Attempting to find and install driver 'uiautomator2'
+✔ Installing 'uiautomator2' using NPM install spec 'appium-uiautomator2-driver'
+Driver uiautomator2@2.0.5 successfully installed
+- automationName: UiAutomator2
+- platformNames: ["Android"]
+```
+
+运行此命令将定位并安装 UiAutomator2 驱动的最新版本，使其可用于自动化。请注意，当安装时，它会告诉你哪些平台它适用（在这种情况下是 `Android`），以及在 Appium 会话中使用此驱动时必须使用的自动化名称（在这种情况下是 `UiAutomator2` 的 `appium:automationName` [capability](../guides/caps.md)）。
+
+!!! note
+
+    在这个快速入门中，我们使用了 [扩展 CLI](../cli/extensions.md) 来安装 UiAutomator2 驱动，但如果你将 Appium 集成到一个 Node.js 项目中，你可能更喜欢使用 `npm` 来管理 Appium 及其相关驱动。要了解更多关于这种技术的信息，请访问关于[管理 Appium 扩展](../guides/managing-exts.md)的指南。
+
+现在，再次启动 Appium 服务器（运行 `appium`），你应该看到新安装的驱动被列为可用：
+
+```
+[Appium] Available drivers:
+[Appium]   - uiautomator2@2.0.5 (automationName 'UiAutomator2')
+```
+
+Android 设置完成并且 UiAutomator2 驱动已安装后，你就可以编写你的第一个测试了！现在选择你喜欢的语言并试一试：
+
+<div class="grid cards" markdown>
+
+-   :material-language-javascript: [__JavaScript__](./test-js.md)
+-   :material-language-java: [__Java__](./test-java.md)
+-   :material-language-python: [__Python__](./test-py.md)
+
+</div>

packages/appium/docs/zh/resources.md

@@ -1,6 +1,20 @@
 ---
-title: 更多 Appium 资源
+hide:
+  - navigation
+  - toc
+
+title: 其他资源
 ---
 
+在这里，您可以找到网络上其他 Appium 资源的链接:
 
-TODO
+## 网站
+
+- [Appium Pro](https://appiumpro.com) - 是Appium其中一名维护者乔纳森-利普斯（Jonathan Lipps）撰写的博客和时事通讯。
+撰写的博客和时事通讯，其中包含大量实用指南
+
+## 在线课程
+
+- [Appium 和 Selenium 基础](https://ui.headspin.io/university/learn/appium-selenium-fundamentals-2020) - Jonathan Lipps 编写的学习 Python、Selenium 和 Appium 的综合视频课程
+- [使用 Appium 实现移动测试自动化](https://testautomationu.applitools.com/appium-java-tutorial/) - 由 Moataz Nabil 制作的视频课程
+- [高级Appoium](https://www.linkedin.com/learning/advanced-appium) - 乔纳森-利普斯（Jonathan Lipps）的视频课程

packages/appium/lib/appium.js

@@ -21,6 +21,10 @@ import {getDefaultsForExtension} from './schema';
 import {DRIVER_TYPE, BIDI_BASE_PATH, BIDI_EVENT_NAME} from './constants';
 import WebSocket from 'ws';
 
+const MIN_WS_CODE_VAL = 1000;
+const MAX_WS_CODE_VAL = 1015;
+const WS_FALLBACK_CODE = 1011; // server encountered an error while fulfilling request
+
 const desiredCapabilityConstraints = /** @type {const} */ ({
   automationName: {
     presence: true,
@@ -418,6 +422,16 @@ class AppiumDriver extends DriverCore {
           `Upstream bidi socket closed connection (code ${code}, reason: '${reason}'). ` +
             `Closing proxy connection to client`,
         );
+        if (!_.isNumber(code)) {
+          code = parseInt(code, 10);
+        }
+        if (_.isNaN(code) || code < MIN_WS_CODE_VAL || code > MAX_WS_CODE_VAL) {
+          this.log.warn(
+            `Received code ${code} from upstream socket, but this is not a valid ` +
+              `websocket code. Rewriting to ${WS_FALLBACK_CODE} for ws compatibility`,
+          );
+          code = WS_FALLBACK_CODE;
+        }
         ws.close(code, reason);
       });
 
@@ -1085,7 +1099,7 @@ class AppiumDriver extends DriverCore {
         // is to do the proxy and retrieve the result internally so it can be passed to the plugin
         // in case it calls 'await next()'. This requires that the driver have defined
         // 'proxyCommand' and not just 'proxyReqRes'.
-        if (!dstSession.proxyCommand) {
+        if (!dstSession?.proxyCommand) {
           throw new NoDriverProxyCommandError();
         }
         return await dstSession.proxyCommand(
@@ -1106,7 +1120,7 @@ class AppiumDriver extends DriverCore {
       }
 
       // here we know that we are executing a session command, and have a valid session driver
-      return await dstSession.executeCommand(cmd, ...args);
+      return await /** @type {any} */ (dstSession).executeCommand(cmd, ...args);
     };
 
     // now take our default behavior, wrap it with any number of plugin behaviors, and run it

packages/appium/lib/cli/args.js

@@ -290,6 +290,16 @@ const serverArgsDisallowedInConfig = new Map([
       help: 'Show info about the Appium build and exit',
     },
   ],
+  [
+    ['--show-debug-info'],
+    {
+      dest: 'showDebugInfo',
+      action: 'store_const',
+      const: true,
+      required: false,
+      help: 'Show debug info about the current Appium deployment and exit',
+    },
+  ],
   [
     ['--show-config'],
     {

packages/appium/lib/cli/driver-command.js

@@ -67,10 +67,11 @@ export default class DriverCliCommand extends ExtensionCliCommand {
   }
 
   /**
-   * Runs doctor checks for the given driver
+   * Runs doctor checks for the given driver.
    *
    * @param {DriverDoctorOptions} opts
-   * @returns {Promise<import('@appium/types').IDoctorCheck[]>}
+   * @returns {Promise<number>} The amount of executed doctor checks.
+   * @throws {Error} If any of the mandatory Doctor checks fails.
    */
   async doctor({driver}) {
     return await super._doctor({

packages/appium/lib/cli/extension-command.js

@@ -16,7 +16,7 @@ import {packageDidChange} from '../extension/package-changed';
 import {spawn} from 'child_process';
 import {inspect} from 'node:util';
 import {pathToFileURL} from 'url';
-import {Doctor} from '../doctor/doctor';
+import {Doctor, EXIT_CODE as DOCTOR_EXIT_CODE} from '../doctor/doctor';
 import {npmPackage} from '../utils';
 import semver from 'semver';
 
@@ -36,13 +36,17 @@ function receiptToManifest(receipt) {
 }
 
 /**
- * Fetches the remote extension version requirement
+ * Fetches the remote extension version requirements
  *
- * @param {string} installSpec Extension name (could also contain the version suffix)
+ * @param {string} pkgName Extension name
+ * @param {string} [pkgVer] Extension version (if not provided then the latest is assumed)
  * @returns {Promise<[string, string|null]>}
  */
-async function getRemoteExtensionVersionReq(installSpec) {
-  const allDeps = await npm.getPackageInfo(installSpec, ['peerDependencies', 'dependencies']);
+async function getRemoteExtensionVersionReq(pkgName, pkgVer) {
+  const allDeps = await npm.getPackageInfo(
+    `${pkgName}${pkgVer ? `@${pkgVer}` : ``}`,
+    ['peerDependencies', 'dependencies']
+  );
   const requiredVersionPair = _.flatMap(_.values(allDeps).map(_.toPairs))
     .find(([name]) => name === 'appium');
   return [npmPackage.version, requiredVersionPair ? requiredVersionPair[1] : null];
@@ -246,13 +250,13 @@ class ExtensionCliCommand {
    * @param {InstallViaNpmArgs} installViaNpmOpts
    * @returns {Promise<void>}
    */
-  async _checkInstallCompatibility({installSpec, pkgName, installType}) {
+  async _checkInstallCompatibility({installSpec, pkgName, pkgVer, installType}) {
     if (INSTALL_TYPE_NPM !== installType) {
       return;
     }
 
     await spinWith(this.isJsonOutput, `Checking if '${pkgName}' is compatible`, async () => {
-      const [serverVersion, extVersionRequirement] = await getRemoteExtensionVersionReq(installSpec);
+      const [serverVersion, extVersionRequirement] = await getRemoteExtensionVersionReq(pkgName, pkgVer);
       if (serverVersion && extVersionRequirement && !semver.satisfies(serverVersion, extVersionRequirement)) {
         throw this._createFatalError(
           `'${installSpec}' cannot be installed because the server version it requires (${extVersionRequirement}) ` +
@@ -738,10 +742,12 @@ class ExtensionCliCommand {
   }
 
   /**
-   * Runs doctor checks for the given extension
+   * Runs doctor checks for the given extension.
    *
    * @param {DoctorOptions} opts
-   * @returns {Promise<import('@appium/types').IDoctorCheck[]>}
+   * @returns {Promise<number>} The amount of Doctor checks that were
+   * successfully loaded and executed for the given extension
+   * @throws {Error} If any of the mandatory Doctor checks fails.
    */
   async _doctor({installSpec}) {
     if (!this.config.isInstalled(installSpec)) {
@@ -765,7 +771,7 @@ class ExtensionCliCommand {
     }
     if (!doctorSpec) {
       this.log.info(`The ${this.type} "${installSpec}" does not export any doctor checks`);
-      return [];
+      return 0;
     }
     if (!_.isPlainObject(doctorSpec) || !_.isArray(doctorSpec.checks)) {
       throw this._createFatalError(
@@ -806,14 +812,17 @@ class ExtensionCliCommand {
       .filter(isDoctorCheck);
     if (_.isEmpty(checks)) {
       this.log.info(`The ${this.type} "${installSpec}" exports no valid doctor checks`);
-      return [];
+      return 0;
     }
     this.log.debug(
       `Running ${util.pluralize('doctor check', checks.length, true)} ` +
       `for the "${installSpec}" ${this.type}`
     );
-    await new Doctor(checks).run();
-    return checks;
+    const exitCode = await new Doctor(checks).run();
+    if (exitCode !== DOCTOR_EXIT_CODE.SUCCESS) {
+      throw this._createFatalError('Treatment required');
+    }
+    return checks.length;
   }
 
   /**

packages/appium/lib/cli/parser.js

@@ -11,11 +11,19 @@ import {
   EXT_SUBCOMMAND_UNINSTALL,
   EXT_SUBCOMMAND_UPDATE,
   PLUGIN_TYPE,
-  SERVER_SUBCOMMAND
+  SERVER_SUBCOMMAND,
+  SETUP_SUBCOMMAND
 } from '../constants';
 import {finalizeSchema, getArgSpec, hasArgSpec} from '../schema';
 import {rootDir} from '../config';
 import {getExtensionArgs, getServerArgs} from './args';
+import {
+  SUBCOMMAND_MOBILE,
+  SUBCOMMAND_DESKTOP,
+  SUBCOMMAND_BROWSER,
+  getPresetDrivers,
+  determinePlatformName
+} from './setup-command';
 
 export const EXTRA_ARGS = 'extraArgs';
 
@@ -24,7 +32,7 @@ export const EXTRA_ARGS = 'extraArgs';
  * will automatially inject the `server` subcommand.
  */
 const NON_SERVER_ARGS = Object.freeze(
-  new Set([DRIVER_TYPE, PLUGIN_TYPE, SERVER_SUBCOMMAND, '-h', '--help', '-v', '--version'])
+  new Set([SETUP_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE, SERVER_SUBCOMMAND, '-h', '--help', '-v', '--version'])
 );
 
 const version = fs.readPackageJsonFrom(rootDir).version;
@@ -76,6 +84,9 @@ class ArgParser {
 
     const subParsers = parser.add_subparsers({dest: 'subcommand'});
 
+    // add the 'setup' command
+    ArgParser._addSetupToParser(subParsers);
+
     // add the 'server' subcommand, and store the raw arguments on the parser
     // object as a way for other parts of the code to work with the arguments
     // conceptually rather than just through argparse
@@ -280,6 +291,45 @@ class ArgParser {
       }
     }
   }
+
+  /**
+   * Add subcommand and sub-sub commands for 'setup' subcommand.
+   * @param {import('argparse').SubParser} subParser
+   */
+  static _addSetupToParser(subParser) {
+    const setupParser = subParser.add_parser('setup', {
+      add_help: true,
+      help: `Select a preset of official drivers/plugins to install ` +
+        `compatible with '${determinePlatformName()}' host platform. ` +
+        `Existing drivers/plugins will remain. The default preset is 'mobile'.`,
+    });
+
+
+    ArgParser._patchExit(setupParser);
+    const extSubParsers = setupParser.add_subparsers({
+      dest: `setupCommand`,
+    });
+
+    const parserSpecs = [
+      {
+        command: SUBCOMMAND_MOBILE,
+        help: `The preset for mobile devices: ${_.join(getPresetDrivers(SUBCOMMAND_MOBILE), ',')}`
+      },
+      {
+        command: SUBCOMMAND_BROWSER,
+        help: `The preset for desktop browser drivers: ${_.join(getPresetDrivers(SUBCOMMAND_BROWSER), ',')}`
+      },
+      {
+        command: SUBCOMMAND_DESKTOP,
+        help: `The preset for desktop application drivers: ${_.join(getPresetDrivers(SUBCOMMAND_DESKTOP), ',')}`
+      },
+    ];
+
+    for (const {command, help} of parserSpecs) {
+      const parser = extSubParsers.add_parser(command, {help});
+      ArgParser._patchExit(parser);
+    }
+  }
 }
 
 /**

packages/appium/lib/cli/plugin-command.js

@@ -69,7 +69,8 @@ export default class PluginCliCommand extends ExtensionCliCommand {
    * Runs doctor checks for the given plugin
    *
    * @param {PluginDoctorOptions} opts
-   * @returns {Promise<import('@appium/types').IDoctorCheck[]>}
+   * @returns {Promise<number>} The amount of executed doctor checks.
+   * @throws {Error} If any of the mandatory Doctor checks fails.
    */
   async doctor({plugin}) {
     return await super._doctor({

packages/appium/lib/cli/setup-command.js

@@ -0,0 +1,185 @@
+import _ from 'lodash';
+import {
+  DESKTOP_BROWSERS,
+  DESKTOP_DRIVERS,
+  MOBILE_DRIVERS
+} from '../constants';
+import {runExtensionCommand} from './extension';
+import { system } from '@appium/support';
+import log from '../logger';
+
+/**
+ * Subcommands of preset for setup
+ */
+export const SUBCOMMAND_MOBILE = 'mobile';
+export const SUBCOMMAND_DESKTOP = 'desktop';
+export const SUBCOMMAND_BROWSER = 'browser';
+
+/**
+ * Pairs of preset subcommand and driver candidates.
+ * Driver names listed in KNOWN_DRIVERS to install by default
+ */
+const PRESET_PAIRS = Object.freeze(
+  /** @type {const} */ ({
+    mobile: _.keys(MOBILE_DRIVERS),
+    desktop: _.keys(DESKTOP_DRIVERS),
+    browser: _.keys(DESKTOP_BROWSERS)
+  }),
+);
+const DRIVERS_ONLY_MACOS = ['xcuitest', 'safari', 'mac2'];
+
+const DRIVERS_ONLY_WINDOWS = ['windows'];
+
+/**
+ * Plugin names listed in KNOWN_PLUGINS to install by default.
+ */
+export const DEFAULT_PLUGINS = ['images'];
+
+/**
+ * Return a list of drivers available for current host platform.
+ * @param {import('appium/types').CliCommandSetupSubcommand} presetName
+ * @returns {Array<string>}
+ */
+export function getPresetDrivers(presetName) {
+  return _.filter(PRESET_PAIRS[presetName], (driver) => {
+    if (_.includes(DRIVERS_ONLY_MACOS, driver)) {
+      return system.isMac();
+    }
+
+    if (_.includes(DRIVERS_ONLY_WINDOWS, driver)) {
+      return system.isWindows();
+    }
+
+    return true;
+  });
+
+}
+
+/**
+ * Return desktop platform name for setup command description.
+ * @returns {string}
+ */
+export function determinePlatformName() {
+  if (system.isMac()) {
+    return 'macOS';
+  } else if (system.isWindows()) {
+    return 'Windows';
+  }
+  return 'Linux';
+}
+
+/**
+ * Run 'setup' command to install drivers/plugins into the given appium home.
+ * @template {import('appium/types').CliCommandSetup} SetupCmd
+ * @param {import('appium/types').Args<SetupCmd>} preConfigArgs
+ * @param {string} appiumHome
+ * @param {DriverConfig} driverConfig
+ * @param {PluginConfig} pluginConfig
+ * @returns {Promise<void>}
+ */
+export async function runSetupCommand(appiumHome, preConfigArgs, driverConfig, pluginConfig) {
+  switch (preConfigArgs.setupCommand) {
+    case SUBCOMMAND_DESKTOP:
+      await setupDesktopAppDrivers(driverConfig);
+      await setupDefaultPlugins(pluginConfig);
+      break;
+    case SUBCOMMAND_BROWSER:
+      await setupBrowserDrivers(driverConfig);
+      await setupDefaultPlugins(pluginConfig);
+      break;
+    default:
+      await setupMobileDrivers(driverConfig);
+      await setupDefaultPlugins(pluginConfig);
+      break;
+  }
+};
+
+/**
+ * Install drivers listed in DEFAULT_DRIVERS.
+ * @param {DriverConfig} driverConfig
+ * @returns {Promise<void>}
+ */
+async function setupMobileDrivers(driverConfig) {
+  await installDrivers(SUBCOMMAND_MOBILE, driverConfig);
+}
+
+/**
+ * Install all of known drivers listed in BROWSER_DRIVERS.
+ * @param {DriverConfig} driverConfig
+ * @returns {Promise<void>}
+ */
+async function setupBrowserDrivers(driverConfig) {
+  await installDrivers(SUBCOMMAND_BROWSER, driverConfig);
+}
+
+/**
+ * Install all of known drivers listed in DESKTOP_APP_DRIVERS.
+ * @param {DriverConfig} driverConfig
+ * @returns {Promise<void>}
+ */
+async function setupDesktopAppDrivers(driverConfig) {
+  await installDrivers(SUBCOMMAND_DESKTOP, driverConfig);
+}
+
+/**
+ * Install the given driver name. It skips the installation if the given driver name was already installed.
+ * @param {import('appium/types').CliCommandSetupSubcommand} subcommand
+ * @param {DriverConfig} driverConfig
+ * @returns {Promise<void>}
+ */
+async function installDrivers(subcommand, driverConfig) {
+  for (const driverName of getPresetDrivers(subcommand)) {
+    await installExtension(driverName, extensionCommandArgs('driver', driverName, 'install'), driverConfig);
+  }
+}
+
+/**
+ * Install plugins listed in DEFAULT_PLUGINS.
+ * @param {PluginConfig} pluginConfig
+ * @returns {Promise<void>}
+ */
+async function setupDefaultPlugins(pluginConfig) {
+  for (const pluginName of DEFAULT_PLUGINS) {
+    await installExtension(pluginName, extensionCommandArgs('plugin', pluginName, 'install'), pluginConfig);
+  }
+}
+
+/**
+ * Run the given extensionConfigArgs command after checking if the given extensionName was already installed.
+ * @param {string} extensionName
+ * @param {Args} extensionConfigArgs
+ * @param {DriverConfig|PluginConfig} extensionConfig
+ * @returns
+ */
+async function installExtension(extensionName, extensionConfigArgs, extensionConfig) {
+  if (_.keys(extensionConfig.installedExtensions).includes(extensionName)) {
+    log.info(`${extensionName} (${extensionConfig.installedExtensions[extensionName].version}) is already installed. ` +
+      `Skipping the installation.`);
+    return;
+  }
+  await runExtensionCommand(extensionConfigArgs, extensionConfig);
+}
+
+/**
+ * Return the command config for driver or plugin.
+ * @param {CliExtensionCommand} extensionCommand
+ * @param {string} extensionName
+ * @param {CliExtensionSubcommand} command
+ * @returns {Args}
+ */
+function extensionCommandArgs(extensionCommand, extensionName, command) {
+  return (extensionCommand === 'plugin')
+    ? {'subcommand': 'plugin', 'pluginCommand': command, 'plugin': extensionName}
+    : {'subcommand': 'driver', 'driverCommand': command, 'driver': extensionName};
+}
+
+/**
+ * @typedef {import('appium/types').CliExtensionCommand} CliExtensionCommand
+ * @typedef {import('appium/types').CliExtensionSubcommand} CliExtensionSubcommand
+ * @typedef {import('../extension/extension-config').ExtensionConfig<CliExtensionCommand>} PluginConfig
+ * @typedef {import('../extension/extension-config').ExtensionConfig<CliExtensionCommand>} DriverConfig
+ */
+
+/**
+ * @typedef {import('appium/types').Args<CliExtensionCommand, CliExtensionSubcommand>} Args
+ */

packages/appium/lib/config.js

@@ -1,16 +1,18 @@
 /* eslint-disable no-console */
 import _ from 'lodash';
-import {system, fs} from '@appium/support';
+import {system, fs, npm} from '@appium/support';
 import axios from 'axios';
 import {exec} from 'teen_process';
 import semver from 'semver';
 import os from 'node:os';
 import {npmPackage} from './utils';
+import B from 'bluebird';
 import {getDefaultsForSchema, getAllArgSpecs} from './schema/schema';
 
 export const APPIUM_VER = npmPackage.version;
 const ENGINES = /** @type {Record<string,string>} */ (npmPackage.engines);
 const MIN_NODE_VERSION = ENGINES.node;
+export const rootDir = fs.findRoot(__dirname);
 
 const GIT_BINARY = `git${system.isWindows() ? '.exe' : ''}`;
 const GITHUB_API = 'https://api.github.com/repos/appium/appium';
@@ -28,8 +30,9 @@ function getNodeVersion() {
 
 /**
  * @param {boolean} [useGithubApiFallback]
+ * @returns {Promise<void>}
  */
-async function updateBuildInfo(useGithubApiFallback = false) {
+export async function updateBuildInfo(useGithubApiFallback = false) {
   const sha = await getGitRev(useGithubApiFallback);
   if (!sha) {
     return;
@@ -50,11 +53,61 @@ const getFullGitPath = _.memoize(async function getFullGitPath() {
   }
 });
 
+/**
+ * Prints server debug into into the console.
+ *
+ * @param {{
+ * driverConfig: import('./extension/driver-config').DriverConfig,
+ * pluginConfig: import('./extension/plugin-config').PluginConfig,
+ * appiumHome: string
+ * }} info
+ * @returns {Promise<void>}
+ */
+export async function showDebugInfo({driverConfig, pluginConfig, appiumHome}) {
+  const getNpmVersion = async () => {
+    const {stdout} = await npm.exec('--version', [], {cwd: process.cwd()});
+    return _.trim(stdout);
+  };
+  const findNpmLocation = async () => await fs.which(system.isWindows() ? 'npm.cmd' : 'npm');
+  const [npmVersion, npmLocation] = await B.all([
+    ...([getNpmVersion, findNpmLocation].map((f) => getSafeResult(f, 'unknown'))),
+    /** @type {any} */ (updateBuildInfo()),
+  ]);
+  const debugInfo = {
+    os: {
+      platform: os.platform(),
+      release: os.release(),
+      arch: os.arch(),
+      homedir: os.homedir(),
+      username: os.userInfo().username,
+    },
+    node: {
+      version: process.version,
+      arch: process.arch,
+      cwd: process.cwd(),
+      argv: process.argv,
+      env: process.env,
+      npm: {
+        location: npmLocation,
+        version: npmVersion,
+      },
+    },
+    appium: {
+      location: rootDir,
+      homedir: appiumHome,
+      build: getBuildInfo(),
+      drivers: driverConfig.installedExtensions,
+      plugins: pluginConfig.installedExtensions,
+    },
+  };
+  console.log(JSON.stringify(debugInfo, null, 2));
+}
+
 /**
  * @param {boolean} [useGithubApiFallback]
  * @returns {Promise<string?>}
  */
-async function getGitRev(useGithubApiFallback = false) {
+export async function getGitRev(useGithubApiFallback = false) {
   const fullGitPath = await getFullGitPath();
   if (fullGitPath) {
     try {
@@ -122,11 +175,15 @@ async function getGitTimestamp(commitSha, useGithubApiFallback = false) {
  * and succeeds.
  * @returns {import('appium/types').BuildInfo}
  */
-function getBuildInfo() {
+export function getBuildInfo() {
   return BUILD_INFO;
 }
 
-function checkNodeOk() {
+/**
+ * @returns {void}
+ * @throws {Error} If Node version is outside of the supported range
+ */
+export function checkNodeOk() {
   const version = getNodeVersion();
   if (!semver.satisfies(version, MIN_NODE_VERSION)) {
     throw new Error(
@@ -135,7 +192,7 @@ function checkNodeOk() {
   }
 }
 
-async function showBuildInfo() {
+export async function showBuildInfo() {
   await updateBuildInfo(true);
   console.log(JSON.stringify(getBuildInfo())); // eslint-disable-line no-console
 }
@@ -145,7 +202,7 @@ async function showBuildInfo() {
  * @param {Args} parsedArgs
  * @returns {Args}
  */
-function getNonDefaultServerArgs(parsedArgs) {
+export function getNonDefaultServerArgs(parsedArgs) {
   /**
    * Flattens parsed args into a single level object for comparison with
    * flattened defaults across server args and extension args.
@@ -253,7 +310,7 @@ const compactConfig = _.partial(
  * @param {Partial<ParsedArgs>} defaults - Configuration defaults from schemas
  * @param {ParsedArgs} parsedArgs - Entire parsed args object
  */
-function showConfig(nonDefaultPreConfigParsedArgs, configResult, defaults, parsedArgs) {
+export function showConfig(nonDefaultPreConfigParsedArgs, configResult, defaults, parsedArgs) {
   console.log('Appium Configuration\n');
   console.log('from defaults:\n');
   console.dir(compactConfig(defaults));
@@ -308,18 +365,22 @@ export async function requireDir(root, requireWriteable = true, displayName = 'f
   }
 }
 
-const rootDir = fs.findRoot(__dirname);
-
-export {
-  getBuildInfo,
-  checkNodeOk,
-  showBuildInfo,
-  getNonDefaultServerArgs,
-  getGitRev,
-  updateBuildInfo,
-  showConfig,
-  rootDir,
-};
+/**
+ * Calculates the result of the given function and return its value
+ * or the default one if there was an exception.
+ *
+ * @template T
+ * @param {() => Promise<T>} f
+ * @param {T} defaultValue
+ * @returns {Promise<T>}
+ */
+async function getSafeResult(f, defaultValue) {
+  try {
+    return await f();
+  } catch {
+    return defaultValue;
+  }
+}
 
 /**
  * @typedef {import('appium/types').ParsedArgs} ParsedArgs

packages/appium/lib/constants.js

@@ -15,6 +15,12 @@ export const PLUGIN_TYPE = 'plugin';
  */
 export const SERVER_SUBCOMMAND = 'server';
 
+/**
+ * The `setup` command of the `appium` CLI
+ */
+export const SETUP_SUBCOMMAND = 'setup';
+
+
 /**
  * The value of `--use-plugins` if _all_ plugins should be loaded
  */
@@ -33,19 +39,38 @@ export const KNOWN_PLUGINS = Object.freeze(
   }),
 );
 
+export const MOBILE_DRIVERS = Object.freeze(
+  /** @type {const} */ ({
+    uiautomator2: 'appium-uiautomator2-driver',
+    xcuitest: 'appium-xcuitest-driver',
+    espresso: 'appium-espresso-driver',
+  }),
+);
+
+export const DESKTOP_DRIVERS = Object.freeze(
+  /** @type {const} */ ({
+    mac2: 'appium-mac2-driver',
+    windows: 'appium-windows-driver',
+  }),
+);
+
+export const DESKTOP_BROWSERS = Object.freeze(
+  /** @type {const} */ ({
+    safari: 'appium-safari-driver',
+    gecko: 'appium-geckodriver',
+    chromium: 'appium-chromium-driver',
+  }),
+);
+
 // This is a map of driver names to npm packages representing those drivers.
 // The drivers in this list will be available to the CLI so users can just
 // type 'appium driver install 'name'', rather than having to specify the full
 // npm package. I.e., these are the officially recognized drivers.
 export const KNOWN_DRIVERS = Object.freeze(
   /** @type {const} */ ({
-    uiautomator2: 'appium-uiautomator2-driver',
-    xcuitest: 'appium-xcuitest-driver',
-    mac2: 'appium-mac2-driver',
-    espresso: 'appium-espresso-driver',
-    safari: 'appium-safari-driver',
-    gecko: 'appium-geckodriver',
-    chromium: 'appium-chromium-driver',
+    ...MOBILE_DRIVERS,
+    ...DESKTOP_DRIVERS,
+    ...DESKTOP_BROWSERS,
   }),
 );
 

packages/appium/lib/doctor/doctor.js

@@ -2,6 +2,11 @@ import '@colors/colors';
 import _ from 'lodash';
 import { util, doctor, logger } from '@appium/support';
 
+export const EXIT_CODE = /** @type {const} */ Object.freeze({
+  SUCCESS: 0,
+  HAS_MAJOR_ISSUES: 127,
+});
+
 export class Doctor {
   /**
    * @param {DoctorCheck[]} [checks=[]]
@@ -68,7 +73,12 @@ export class Doctor {
       /** @type {string[]} */
       const fixMessages = [];
       for (const issue of issues) {
-        const message = await issue.check.fix();
+        let message;
+        try {
+          message = await issue.check.fix();
+        } catch (e) {
+          message = e.message;
+        }
         if (message) {
           fixMessages.push(message);
         }
@@ -84,7 +94,7 @@ export class Doctor {
       'The configuration cannot be automatically fixed, please do the following first:',
     ], manualIssues);
     await handleIssues([
-      '### Optional Manual Fixes  ###',
+      '### Optional Manual Fixes ###',
       'To fix these optional issues, please do the following manually:',
     ], manualIssuesOptional);
 
@@ -127,6 +137,9 @@ export class Doctor {
     }
   }
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   async runAutoFixes() {
     const autoFixes = _.filter(this.foundIssues, (f) => f.check.hasAutofix());
     for (const f of autoFixes) {
@@ -136,22 +149,30 @@ export class Doctor {
     if (_.find(autoFixes, (f) => !f.fixed)) {
       // a few issues remain.
       this.log.info('Bye! A few issues remain, fix manually and/or rerun doctor!');
-    } else {
-      // nothing left to fix.
-      this.log.info('Bye! All issues have been fixed!');
+      this.log.info('');
+      return false;
     }
+    // nothing left to fix.
+    this.log.info('Bye! All issues have been fixed!');
     this.log.info('');
+    return true;
   }
 
+  /**
+   * @returns {Promise<EXIT_CODE[keyof EXIT_CODE]>}
+   */
   async run() {
     await this.diagnose();
     if (this.reportSuccess()) {
-      return;
+      return EXIT_CODE.SUCCESS;
     }
     if (await this.reportManualIssues()) {
-      return;
+      return EXIT_CODE.HAS_MAJOR_ISSUES;
     }
-    await this.runAutoFixes();
+    if (!await this.runAutoFixes()) {
+      return EXIT_CODE.HAS_MAJOR_ISSUES;
+    }
+    return EXIT_CODE.SUCCESS;
   }
 
   /**

packages/appium/lib/extension/extension-config.js

@@ -311,7 +311,9 @@ export class ExtensionConfig {
       const invalidFieldsText = invalidFields.map((field) => `"${field}"`).join(', ');
 
       warnings.push(
-        `${extTypeText} "${extName}" (package \`${pkgName}\`) has ${invalidFieldsEnumerationText} (${invalidFieldsText}) in \`extensions.yaml\`; this may cause upgrades done via the \`appium\` CLI tool to fail. Please reinstall with \`appium ${this.extensionType} uninstall ${extName}\` and \`appium ${this.extensionType} install ${extName}\` to attempt a fix.`
+        `${extTypeText} "${extName}" (package \`${pkgName}\`) has ${invalidFieldsEnumerationText} (${invalidFieldsText}) in \`extensions.yaml\`; ` +
+        `this may cause upgrades done via the \`appium\` CLI tool to fail. Please reinstall with \`appium ${this.extensionType} uninstall ` +
+        `${extName}\` and \`appium ${this.extensionType} install ${extName}\` to attempt a fix.`
       );
     }
 
@@ -331,16 +333,16 @@ export class ExtensionConfig {
         );
       if (extListData?.installed) {
         const {updateVersion, upToDate} = extListData;
-        if (!upToDate) {
+        if (!upToDate && updateVersion) {
           warnings.push(
             createPeerWarning(
-              `its peer dependency on older Appium v${appiumVersion}. Please upgrade \`${pkgName}\` to v${updateVersion} or newer.`
+              `its peer dependency on Appium ${appiumVersion}. Try to upgrade \`${pkgName}\` to v${updateVersion} or newer.`
             )
           );
         } else {
           warnings.push(
             createPeerWarning(
-              `its peer dependency on older Appium v${appiumVersion}. Please ask the developer of \`${pkgName}\` to update the peer dependency on Appium to v${APPIUM_VER}.`
+              `its peer dependency on Appium ${appiumVersion}. Please install a compatible version of the ${_.toLower(extTypeText)}.`
             )
           );
         }
@@ -354,13 +356,15 @@ export class ExtensionConfig {
       if (!extListData?.upToDate && extListData?.updateVersion) {
         warnings.push(
           createPeerWarning(
-            `an invalid or missing peer dependency on Appium. A newer version of \`${pkgName}\` is available; please attempt to upgrade "${extName}" to v${extListData.updateVersion} or newer.`
+            `an invalid or missing peer dependency on Appium. A newer version of \`${pkgName}\` is available; ` +
+            `please attempt to upgrade "${extName}" to v${extListData.updateVersion} or newer.`
           )
         );
       } else {
         warnings.push(
           createPeerWarning(
-            `an invalid or missing peer dependency on Appium. Please ask the developer of \`${pkgName}\` to add a peer dependency on \`^appium@${APPIUM_VER}\`.`
+            `an invalid or missing peer dependency on Appium. ` +
+            `Please ask the developer of \`${pkgName}\` to add a peer dependency on \`^appium@${APPIUM_VER}\`.`
           )
         );
       }

packages/appium/lib/grid-register.js

@@ -57,13 +57,13 @@ function postRequest(configHolder, addr, port, basePath) {
   // Move Selenium 3 configuration properties to configuration object
   if (!_.has(configHolder, 'configuration')) {
     let configuration = {};
-    for (const property in configHolder) {
+    for (const property in /** @type {import('@appium/types').StringRecord} */ (configHolder)) {
       if (_.has(configHolder, property) && property !== 'capabilities') {
         configuration[property] = configHolder[property];
         delete configHolder[property];
       }
     }
-    configHolder.configuration = configuration;
+    /** @type {import('@appium/types').StringRecord} */ (configHolder).configuration = configuration;
   }
 
   // if the node config does not have the appium/webdriver url, host, and port,

packages/appium/lib/logsink.js

@@ -1,30 +1,27 @@
-import npmlog from 'npmlog';
+import globalLog from '@appium/logger';
 import {createLogger, format, transports} from 'winston';
-import {fs, logger} from '@appium/support';
-import { APPIUM_LOGGER_NAME } from './logger';
+import {fs} from '@appium/support';
 import _ from 'lodash';
+import { adler32 } from './utils';
+import { LRUCache } from 'lru-cache';
 
 // set up distributed logging before everything else
-logger.patchLogger(npmlog);
-global._global_npmlog = npmlog;
-
+global._global_npmlog = globalLog;
 // npmlog is used only for emitting, we use winston for output
-npmlog.level = 'info';
-const levels = {
+globalLog.level = 'info';
+const LEVELS_MAP = {
   debug: 4,
   info: 3,
   warn: 2,
   error: 1,
 };
-
-const colors = {
+const COLORS_MAP = {
   info: 'cyan',
   debug: 'grey',
   warn: 'yellow',
   error: 'red',
 };
-
-const npmToWinstonLevels = {
+const TO_WINSTON_LEVELS_MAP = {
   silly: 'debug',
   verbose: 'debug',
   debug: 'debug',
@@ -33,36 +30,106 @@ const npmToWinstonLevels = {
   warn: 'warn',
   error: 'error',
 };
+const COLOR_CODE_PATTERN = /\u001b\[(\d+(;\d+)*)?m/g; // eslint-disable-line no-control-regex
 
-const encounteredPrefixes = [];
-
-let log = null;
-let useLocalTimeZone = false;
-
-// add the timestamp in the correct format to the log info object
-const timestampFormat = format.timestamp({
-  format() {
-    let date = new Date();
-    if (useLocalTimeZone) {
-      date = new Date(date.valueOf() - date.getTimezoneOffset() * 60000);
-    }
-    // '2012-11-04T14:51:06.157Z' -> '2012-11-04 14:51:06:157'
-    return date.toISOString().replace(/[TZ]/g, ' ').replace(/\./g, ':').trim();
-  },
+// https://www.ditig.com/publications/256-colors-cheat-sheet
+const MIN_COLOR = 17;
+const MAX_COLOR = 231;
+/** @type {LRUCache<string, number>} */
+const COLORS_CACHE = new LRUCache({
+  max: 1024,
+  ttl: 1000 * 60 * 60 * 24, // expire after 24 hours
+  updateAgeOnGet: true,
 });
 
+/** @type {import('winston').Logger?} */
+let log = null;
+
+/**
+ *
+ * @param {import('../types').ParsedArgs} args
+ * @returns {Promise<void>}
+ */
+export async function init(args) {
+  globalLog.level = 'silent';
+
+  // clean up in case we have initiated before since npmlog is a global object
+  clear();
+
+  const transports = await createTransports(args);
+  const transportNames = new Set(transports.map((tr) => tr.constructor.name));
+  log = createLogger({
+    transports,
+    levels: LEVELS_MAP,
+  });
+
+  const reportedLoggerErrors = new Set();
+  // Capture logs emitted via npmlog and pass them through winston
+  globalLog.on('log', (/** @type {MessageObject} */{level, message, prefix}) => {
+    const {sessionSignature} = globalLog.asyncStorage.getStore() ?? {};
+    /** @type {string[]} */
+    const prefixes = [];
+    if (sessionSignature) {
+      prefixes.push(sessionSignature);
+    }
+    if (prefix) {
+      prefixes.push(prefix);
+    }
+    let msg = message;
+    if (!_.isEmpty(prefixes)) {
+      const finalPrefix = prefixes
+        .map(toDecoratedPrefix)
+        .map((pfx) => isLogColorEnabled(args) ? colorizePrefix(pfx) : pfx)
+        .join('');
+      msg = `${finalPrefix} ${msg}`;
+    }
+    const winstonLevel = TO_WINSTON_LEVELS_MAP[level] || 'info';
+    try {
+      /** @type {import('winston').Logger} */(log)[winstonLevel](msg);
+      if (_.isFunction(args.logHandler)) {
+        args.logHandler(level, msg);
+      }
+    } catch (e) {
+      if (!reportedLoggerErrors.has(e.message) && process.stderr.writable) {
+        // eslint-disable-next-line no-console
+        console.error(
+          `The log message '${_.truncate(msg, {length: 30})}' cannot be written into ` +
+          `one or more requested destinations: ${transportNames}. Original error: ${e.message}`
+        );
+        reportedLoggerErrors.add(e.message);
+      }
+    }
+  });
+}
+
+/**
+ * @returns {void}
+ */
+export function clear() {
+  log?.clear();
+  globalLog.removeAllListeners('log');
+}
+
 // set the custom colors
 const colorizeFormat = format.colorize({
-  colors,
+  colors: COLORS_MAP,
 });
 
 // Strip the color marking within messages
 const stripColorFormat = format(function stripColor(info) {
-  const code = /\u001b\[(\d+(;\d+)*)?m/g; // eslint-disable-line no-control-regex
-  info.message = info.message.replace(code, '');
-  return info;
+  return {
+    ...info,
+    level: stripColorCodes(info.level),
+    message: stripColorCodes(info.message),
+  };
 })();
 
+/**
+ *
+ * @param {ParsedArgs} args
+ * @param {string} logLvl
+ * @returns {transports.ConsoleTransportInstance}
+ */
 function createConsoleTransport(args, logLvl) {
   return new transports.Console({
     // @ts-expect-error The 'name' property should exist
@@ -73,15 +140,19 @@ function createConsoleTransport(args, logLvl) {
     level: logLvl,
     stderrLevels: ['error'],
     format: format.combine(
-      timestampFormat,
-      args.logNoColors ? stripColorFormat : colorizeFormat,
-      format.printf(function printInfo(info) {
-        return `${args.logTimestamp ? `${info.timestamp} - ` : ''}${info.message}`;
-      })
+      formatTimestamp(args),
+      isLogColorEnabled(args) ? colorizeFormat : stripColorFormat,
+      format.printf(formatLogLine(args, true))
     ),
   });
 }
 
+/**
+ *
+ * @param {ParsedArgs} args
+ * @param {string} logLvl
+ * @returns {transports.FileTransportInstance}
+ */
 function createFileTransport(args, logLvl) {
   return new transports.File({
     // @ts-expect-error The 'name' property should exist
@@ -94,19 +165,23 @@ function createFileTransport(args, logLvl) {
     level: logLvl,
     format: format.combine(
       stripColorFormat,
-      timestampFormat,
-      format.printf(function printInfo(info) {
-        return `${info.timestamp} ${info.message}`;
-      })
+      formatTimestamp(args),
+      format.printf(formatLogLine(args, false))
     ),
   });
 }
 
+/**
+ *
+ * @param {ParsedArgs} args
+ * @param {string} logLvl
+ * @returns {transports.HttpTransportInstance}
+ */
 function createHttpTransport(args, logLvl) {
   let host = '127.0.0.1';
   let port = 9003;
 
-  if (args.webhook.match(':')) {
+  if (args.webhook?.match(':')) {
     const hostAndPort = args.webhook.split(':');
     host = hostAndPort[0];
     port = parseInt(hostAndPort[1], 10);
@@ -124,23 +199,26 @@ function createHttpTransport(args, logLvl) {
     level: logLvl,
     format: format.combine(
       stripColorFormat,
-      format.printf(function printInfo(info) {
-        return `${info.timestamp} ${info.message}`;
-      })
+      format.printf(formatLogLine(args, false))
     ),
   });
 }
 
+/**
+ *
+ * @param {ParsedArgs} args
+ * @returns {Promise<import('winston-transport')[]>}
+ */
 async function createTransports(args) {
-  let transports = [];
-  let consoleLogLevel = null;
-  let fileLogLevel = null;
-
+  const transports = [];
+  /** @type {string} */
+  let consoleLogLevel;
+  /** @type {string} */
+  let fileLogLevel;
   if (args.loglevel && args.loglevel.match(':')) {
     // --log-level arg can optionally provide diff logging levels for console and file, separated by a colon
     const lvlPair = args.loglevel.split(':');
-    consoleLogLevel = lvlPair[0] || consoleLogLevel;
-    fileLogLevel = lvlPair[1] || fileLogLevel;
+    [consoleLogLevel, fileLogLevel] = lvlPair;
   } else {
     consoleLogLevel = fileLogLevel = args.loglevel;
   }
@@ -180,58 +258,95 @@ async function createTransports(args) {
   return transports;
 }
 
-function getColorizedPrefix(prefix) {
-  let prefixId = prefix.split('@')[0].trim();
-  prefixId = prefixId.split(' (')[0].trim();
-  if (encounteredPrefixes.indexOf(prefixId) < 0) {
-    encounteredPrefixes.push(prefixId);
-  }
-  // using a multiple of 16 should cause 16 colors to be created
-  const colorNumber = encounteredPrefixes.indexOf(prefixId) * 16;
-  // use the modulus to cycle around color wheel
-  return `\x1b[38;5;${colorNumber % 256}m${prefix}\x1b[0m`;
+/**
+ *
+ * @param {string} text
+ * @returns {string}
+ */
+function toDecoratedPrefix(text) {
+  return `[${text}]`;
 }
 
-async function init(args) {
-  npmlog.level = 'silent';
+/**
+ * Selects the color of the text in terminal from the MIN_COLOR..MAX_COLOR
+ * range. We use adler32 hashing to ensure that equal prefixes would always have
+ * same colors.
+ *
+ * @param {string} text Initial text
+ * @returns {string} Colorized text (with pseudocode cchars added)
+ */
+function colorizePrefix(text) {
+  let colorIndex = COLORS_CACHE.get(text);
+  if (!colorIndex) {
+    const hash = adler32(text);
+    colorIndex = MIN_COLOR + hash % (MAX_COLOR - MIN_COLOR);
+    COLORS_CACHE.set(text, colorIndex);
+  }
+  return `\x1b[38;5;${colorIndex}m${text}\x1b[0m`;
+}
 
-  // set de facto param passed to timestamp function
-  useLocalTimeZone = args.localTimezone;
-
-  // clean up in case we have initiated before since npmlog is a global object
-  clear();
-
-  log = createLogger({
-    transports: await createTransports(args),
-    levels,
-  });
-
-  // Capture logs emitted via npmlog and pass them through winston
-  npmlog.on('log', ({level, message, prefix}) => {
-    const winstonLevel = npmToWinstonLevels[level] || 'info';
-    let msg = message;
-    if (prefix) {
-      const decoratedPrefix = `[${prefix}]`;
-      const toColorizedDecoratedPrefix = () => prefix === APPIUM_LOGGER_NAME
-        ? decoratedPrefix.magenta
-        : getColorizedPrefix(decoratedPrefix);
-      msg = `${args.logNoColors ? decoratedPrefix : toColorizedDecoratedPrefix()} ${msg}`;
+/**
+ * @param {ParsedArgs} args
+ * @param {boolean} targetConsole
+ * @returns {(info: import('logform').TransformableInfo) => string}
+ */
+function formatLogLine(args, targetConsole) {
+  return (info) => {
+    if (['json', 'pretty_json'].includes(args.logFormat)) {
+      let infoCopy = {...info};
+      if (targetConsole && !args.logTimestamp) {
+        delete infoCopy.timestamp;
+      }
+      return JSON.stringify(infoCopy, null, args.logFormat === 'pretty_json' ? 2 : undefined);
     }
-    log[winstonLevel](msg);
-    if (args.logHandler && _.isFunction(args.logHandler)) {
-      args.logHandler(level, msg);
+    if (targetConsole) {
+      return `${args.logTimestamp ? `${info.timestamp} - ` : ''}${info.message}`;
     }
+    return `${info.timestamp} ${info.message}`;
+  };
+}
+
+/**
+ * add the timestamp in the correct format to the log info object
+ *
+ * @param {ParsedArgs} args
+ * @returns {import('logform').Format}
+ */
+function formatTimestamp(args) {
+  return format.timestamp({
+    format() {
+      let date = new Date();
+      if (args.localTimezone) {
+        date = new Date(date.valueOf() - date.getTimezoneOffset() * 60000);
+      }
+      // '2012-11-04T14:51:06.157Z' -> '2012-11-04 14:51:06:157'
+      return date.toISOString().replace(/[TZ]/g, ' ').replace(/\./g, ':').trim();
+    },
   });
 }
 
-function clear() {
-  if (log) {
-    for (let transport of _.keys(log.transports)) {
-      log.remove(transport);
-    }
-  }
-  npmlog.removeAllListeners('log');
+/**
+ * Strips color control codes from the given string
+ *
+ * @param {string} text
+ * @returns {string}
+ */
+function stripColorCodes(text) {
+  return text.replace(COLOR_CODE_PATTERN, '');
+}
+
+/**
+ *
+ * @param {ParsedArgs} args
+ * @returns {boolean}
+ */
+function isLogColorEnabled(args) {
+  return !args.logNoColors && args.logFormat === 'text';
 }
 
-export {init, clear};
 export default init;
+
+/**
+ * @typedef {import('appium/types').ParsedArgs} ParsedArgs
+ * @typedef {import('@appium/logger').MessageObject} MessageObject
+ */

packages/appium/lib/main.js

@@ -8,11 +8,12 @@ import {
   server as baseServer,
   normalizeBasePath,
 } from '@appium/base-driver';
-import {logger as logFactory, util, env} from '@appium/support';
+import {util, env} from '@appium/support';
 import {asyncify} from 'asyncbox';
 import _ from 'lodash';
 import {AppiumDriver} from './appium';
 import {runExtensionCommand} from './cli/extension';
+import { runSetupCommand } from './cli/setup-command';
 import {getParser} from './cli/parser';
 import {
   APPIUM_VER,
@@ -21,6 +22,7 @@ import {
   getNonDefaultServerArgs,
   showConfig,
   showBuildInfo,
+  showDebugInfo,
   requireDir,
 } from './config';
 import {readConfigFile} from './config-file';
@@ -38,6 +40,7 @@ import {
   fetchInterfaces,
   V4_BROADCAST_IP,
   V6_BROADCAST_IP,
+  isSetupCommandArgs,
 } from './utils';
 import net from 'node:net';
 
@@ -216,7 +219,7 @@ async function init(args) {
   }
 
   // merge config and apply defaults.
-  // the order of precendece is:
+  // the order of precedence is:
   // 1. command line args
   // 2. config file
   // 3. defaults from config file.
@@ -231,10 +234,19 @@ async function init(args) {
       return /** @type {InitResult<Cmd>} */ ({});
     }
 
+    if (preConfigArgs.showDebugInfo) {
+      await showDebugInfo({
+        driverConfig,
+        pluginConfig,
+        appiumHome,
+      });
+      return /** @type {InitResult<Cmd>} */ ({});
+    }
+
     await logsinkInit(serverArgs);
 
     if (serverArgs.logFilters) {
-      const {issues, rules} = await logFactory.loadSecureValuesPreprocessingRules(
+      const {issues, rules} = await logger.unwrap().loadSecureValuesPreprocessingRules(
         serverArgs.logFilters,
       );
       if (!_.isEmpty(issues)) {
@@ -248,10 +260,10 @@ async function init(args) {
           `Found no log filtering rules in '${serverArgs.logFilters}'. Is that expected?`,
         );
       } else {
+        // Filtering aims to "hide" these values from the log,
+        // so it would be nice to not show them in the log as well.
         logger.info(
-          `Loaded ${util.pluralize('filtering rule', rules.length, true)} from '${
-            serverArgs.logFilters
-          }'`,
+          `Loaded ${util.pluralize('filtering rule', rules.length, true)}`,
         );
       }
     }
@@ -276,6 +288,9 @@ async function init(args) {
       pluginConfig,
       appiumHome,
     });
+  } else if (isSetupCommandArgs(preConfigArgs)) {
+    await runSetupCommand(appiumHome, preConfigArgs, driverConfig, pluginConfig);
+    return /** @type {InitResult<Cmd>} */ ({});
   } else {
     await requireDir(appiumHome, true, appiumHomeSourceName);
     if (isExtensionCommandArgs(preConfigArgs)) {
@@ -465,6 +480,7 @@ export {main, init, resolveAppiumHome};
  * @typedef {import('appium/types').CliCommandServer} ServerCommand
  * @typedef {import('appium/types').CliCommandDriver} DriverCommand
  * @typedef {import('appium/types').CliCommandPlugin} PluginCommand
+ * @typedef {import('appium/types').CliCommandSetup} SetupCommand
  * @typedef {import('./extension').DriverNameMap} DriverNameMap
  * @typedef {import('./extension').PluginNameMap} PluginNameMap
  */

packages/appium/lib/schema/cli-args.js

@@ -2,7 +2,7 @@ import {ArgumentTypeError} from 'argparse';
 import _ from 'lodash';
 import {formatErrors as formatErrors} from '../config-file';
 import {flattenSchema, validate} from './schema';
-import {transformers} from './cli-transformers';
+import {transformers, parseCsvLine} from './cli-transformers';
 
 /**
  * This module concerns functions which convert schema definitions to
@@ -136,13 +136,19 @@ function subSchemaToArgDef(subSchema, argSpec) {
     }
 
     case TYPENAMES.OBJECT: {
-      argTypeFunction = transformers.json;
+      argTypeFunction = _.flow(transformers.json, (o) => {
+        // Arrays and plain strings are also valid JSON
+        if (!_.isPlainObject(o)) {
+          throw new ArgumentTypeError(`'${_.truncate(o, {length: 100})}' must be a plain object`);;
+        }
+        return o;
+      });
       break;
     }
 
     // arrays are treated as CSVs, because `argparse` doesn't handle array data.
     case TYPENAMES.ARRAY: {
-      argTypeFunction = transformers.csv;
+      argTypeFunction = parseCsvLine;
       break;
     }
 
@@ -182,12 +188,13 @@ function subSchemaToArgDef(subSchema, argSpec) {
     argOpts.metavar = screamingSnakeCase(name);
   }
 
-  // the validity of "appiumCliTransformer" should already have been determined
-  // by ajv during schema validation in `finalizeSchema()`. the `array` &
-  // `object` types have already added a formatter (see above, so we don't do it
-  // twice).
-  if (type !== TYPENAMES.ARRAY && type !== TYPENAMES.OBJECT && appiumCliTransformer) {
-    argTypeFunction = _.flow(argTypeFunction ?? _.identity, transformers[appiumCliTransformer]);
+  if (appiumCliTransformer && transformers[appiumCliTransformer]) {
+    if (type === TYPENAMES.ARRAY) {
+      const csvTransformer = /** @type {(x: string) => string[]} */ (argTypeFunction);
+      argTypeFunction = (val) => _.flatMap(csvTransformer(val).map(transformers[appiumCliTransformer]));
+    } else {
+      argTypeFunction = _.flow(argTypeFunction ?? _.identity, transformers[appiumCliTransformer]);
+    }
   }
 
   if (argTypeFunction) {

packages/appium/lib/schema/cli-transformers.js

@@ -1,6 +1,5 @@
 import {ArgumentTypeError} from 'argparse';
 import {readFileSync, existsSync} from 'fs';
-import _ from 'lodash';
 
 /**
  * This module provides custom keywords for Appium schemas, as well as
@@ -16,7 +15,7 @@ import _ from 'lodash';
  * @param {string} value
  * @returns {string[]}
  */
-function parseCsvLine(value) {
+export function parseCsvLine(value) {
   return value
     .split(',')
     .map((v) => v.trim())
@@ -71,7 +70,6 @@ export const transformers = {
       }
       loadedFromFile = true;
     }
-
     try {
       return loadedFromFile ? parseCsvFile(csv) : parseCsvLine(csv);
     } catch (err) {
@@ -104,14 +102,10 @@ export const transformers = {
       loadedFromFile = true;
     }
     try {
-      const result = JSON.parse(json);
-      if (!_.isPlainObject(result)) {
-        throw new Error(`'${_.truncate(result, {length: 100})}' is not an object`);
-      }
-      return result;
+      return JSON.parse(json);
     } catch (e) {
       const msg = loadedFromFile
-        ? `The provided value of '${jsonOrPath}' must be a valid JSON`
+        ? `'${jsonOrPath}' must be a valid JSON`
         : `The provided value must be a valid JSON`;
       throw new TypeError(`${msg}. Original error: ${e.message}`);
     }

packages/appium/lib/utils.js

@@ -4,7 +4,7 @@ import {processCapabilities, PROTOCOLS, STANDARD_CAPS, errors} from '@appium/bas
 import {inspect as dump} from 'util';
 import {node, fs} from '@appium/support';
 import path from 'path';
-import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE} from './constants';
+import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE, SETUP_SUBCOMMAND} from './constants';
 import os from 'node:os';
 
 const W3C_APPIUM_PREFIX = 'appium';
@@ -330,6 +330,16 @@ export function isServerCommandArgs(args) {
   return args.subcommand === SERVER_SUBCOMMAND;
 }
 
+/**
+ * @template {CliCommand} Cmd
+ * @template {CliExtensionSubcommand|CliCommandSetupSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<SetupCommand>}
+ */
+export function isSetupCommandArgs(args) {
+  return args.subcommand === SETUP_SUBCOMMAND;
+}
+
 /**
  * @template {CliCommand} [Cmd=ServerCommand]
  * @template {CliExtensionSubcommand|void} [SubCmd=void]
@@ -381,6 +391,62 @@ export function fetchInterfaces (family = null) {
     .filter(({family}) => !familyValue || familyValue && familyValue.includes(family));
 }
 
+/**
+ * https://github.com/SheetJS/js-adler32
+ *
+ * @param {string} str
+ * @param {number?} [seed]
+ * @returns {number}
+ */
+export function adler32(str, seed = null) {
+	let a = 1, b = 0, L = str.length, M = 0, c = 0, d = 0;
+	if (typeof seed === 'number') {
+    a = seed & 0xFFFF;
+    b = seed >>> 16;
+  }
+	for (let i = 0; i < L;) {
+		M = Math.min(L - i, 2918);
+		while (M > 0) {
+			c = str.charCodeAt(i++);
+			if (c < 0x80) {
+        a += c;
+      }
+			else if (c < 0x800) {
+				a += 192 | ((c >> 6) & 31);
+        b += a;
+        --M;
+				a += 128 | (c & 63);
+			} else if (c >= 0xD800 && c < 0xE000) {
+				c = (c & 1023) + 64;
+        d = str.charCodeAt(i++) & 1023;
+				a += 240 | ((c >> 8) & 7);
+        b += a;
+        --M;
+				a += 128 | ((c >> 2) & 63);
+        b += a;
+        --M;
+				a += 128 | ((d >> 6) & 15) | ((c & 3) << 4);
+        b += a;
+        --M;
+				a += 128 | (d & 63);
+			} else {
+				a += 224 | ((c >> 12) & 15);
+        b += a;
+        --M;
+				a += 128 | ((c >> 6) & 63);
+        b += a;
+        --M;
+				a += 128 | (c & 63);
+			}
+			b += a;
+      --M;
+		}
+		a = (15 * (a >>> 16) + (a & 65535));
+		b = (15 * (b >>> 16) + (b & 65535));
+	}
+	return ((b % 65521) << 16) | (a % 65521);
+}
+
 export {
   inspect,
   parseCapsForInnerDriver,
@@ -451,19 +517,21 @@ export {
  * @typedef {import('appium/types').CliCommand} CliCommand
  * @typedef {import('appium/types').CliExtensionSubcommand} CliExtensionSubcommand
  * @typedef {import('appium/types').CliExtensionCommand} CliExtensionCommand
+ * @typedef {import('appium/types').CliCommandSetupSubcommand} CliCommandSetupSubcommand
  * @typedef {import('appium/types').CliCommandServer} ServerCommand
  * @typedef {import('appium/types').CliCommandDriver} DriverCommand
  * @typedef {import('appium/types').CliCommandPlugin} PluginCommand
+ * @typedef {import('appium/types').CliCommandSetup} SetupCommand
  */
 
 /**
  * @template {CliCommand} [Cmd=ServerCommand]
- * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @template {CliExtensionSubcommand|CliCommandSetupSubcommand|void} [SubCmd=void]
  * @typedef {import('appium/types').Args<Cmd, SubCmd>} Args
  */
 
 /**
  * @template {CliCommand} [Cmd=ServerCommand]
- * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @template {CliExtensionSubcommand|CliCommandSetupSubcommand|void} [SubCmd=void]
  * @typedef {import('appium/types').ParsedArgs<Cmd, SubCmd>} ParsedArgs
  */

packages/appium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.4.0",
+  "version": "2.10.3",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -45,10 +45,9 @@
   "scripts": {
     "build:docs": "node docs/scripts/build-docs.js",
     "build:docs:preview": "cross-env APPIUM_DOCS_PREVIEW=1 npm run build:docs",
-    "build:docs:assets": "node docs/scripts/copy-assets.js",
     "build:docs:cli": "node docs/scripts/gen-cli-args-docs.js",
     "build:docs:reference": "node docs/scripts/build-reference.js",
-    "dev:docs": "npm run build:docs:assets && npm run dev:docs:en",
+    "dev:docs": "npm run dev:docs:en",
     "dev:docs:en": "appium-docs build --serve --mkdocs-yml ./docs/mkdocs-en.yml",
     "dev:docs:ja": "appium-docs build --serve --mkdocs-yml ./docs/mkdocs-ja.yml",
     "dev:docs:zh": "appium-docs build --serve --mkdocs-yml ./docs/mkdocs-zh.yml",
@@ -60,41 +59,42 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.5.0",
-    "@appium/base-plugin": "^2.2.26",
-    "@appium/docutils": "^1.0.2",
-    "@appium/schema": "~0.5.0",
-    "@appium/support": "^4.2.0",
-    "@appium/types": "^0.16.0",
+    "@appium/base-driver": "^9.10.3",
+    "@appium/base-plugin": "^2.2.39",
+    "@appium/docutils": "^1.0.15",
+    "@appium/logger": "^1.4.2",
+    "@appium/schema": "^0.6.1",
+    "@appium/support": "^5.0.3",
+    "@appium/types": "^0.20.3",
     "@sidvind/better-ajv-errors": "2.1.3",
-    "@types/argparse": "2.0.14",
+    "@types/argparse": "2.0.16",
     "@types/bluebird": "3.5.42",
     "@types/fancy-log": "2.0.2",
-    "@types/semver": "7.5.6",
+    "@types/semver": "7.5.8",
     "@types/teen_process": "2.0.4",
     "@types/wrap-ansi": "3.0.0",
-    "ajv": "8.12.0",
-    "ajv-formats": "2.1.1",
+    "ajv": "8.16.0",
+    "ajv-formats": "3.0.1",
     "argparse": "2.0.1",
     "async-lock": "1.4.1",
     "asyncbox": "3.0.0",
-    "axios": "1.6.3",
+    "axios": "1.7.2",
     "bluebird": "3.7.2",
     "cross-env": "7.0.3",
-    "lilconfig": "3.0.0",
+    "lilconfig": "3.1.2",
     "lodash": "4.17.21",
-    "npmlog": "7.0.1",
+    "lru-cache": "10.2.2",
     "ora": "5.4.1",
     "package-changed": "3.0.0",
     "resolve-from": "5.0.0",
-    "semver": "7.5.4",
+    "semver": "7.6.2",
     "source-map-support": "0.5.21",
-    "teen_process": "2.1.1",
-    "type-fest": "4.9.0",
-    "winston": "3.11.0",
+    "teen_process": "2.1.4",
+    "type-fest": "4.20.0",
+    "winston": "3.13.0",
     "wrap-ansi": "7.0.0",
-    "ws": "8.16.0",
-    "yaml": "2.3.4"
+    "ws": "8.17.0",
+    "yaml": "2.4.5"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",