appium-mcp 0.0.1 → 1.1.4

package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/env-vars.md

@@ -0,0 +1,31 @@
+---
+hide:
+  - toc
+
+title: Environment Variables
+---
+
+The primary ways of configuring the Appium server are via [Command-Line Arguments](./server.md) or
+the [Config File](../../guides/config.md). However, some more advanced features are toggled or
+configured via environment variables. To set environment variables, refer to the documentation for
+your operating system and terminal.
+
+These are the environment variables that the Appium server understands:
+
+| <div style="width:18em">Variable</div> | Description                                                                                                                                                                                                                                                                             |
+| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `APPIUM_APPS_CACHE_IGNORE_URL_QUERY`   | Set this to a truthy value to remove any query part of a URL when using it as a cache key. See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713) for more details.          |
+| `APPIUM_APPS_CACHE_MAX_AGE`            | Set the maximum age (in minutes) for [cached applications](../../guides/caching.md). Do not set it to a lower number than the duration of a single session startup. Default: `60 * 24` (24 hours) |
+| `APPIUM_APPS_CACHE_MAX_ITEMS`          | Set the maximum amount of [cached applications](../../guides/caching.md). Do not set it to a lower number than the amount of apps in all parallel sessions per process. Default: `1024`                                                 |
+| `APPIUM_HOME`                          | Set the path to the Appium home directory, which is used for [Managing Extensions](../../guides/managing-exts.md). Default: `.appium` in the home directory of the current user                                                                         |
+| `APPIUM_OMIT_PEER_DEPS`                | Set this to `1` to add `--omit=peer` to all the NPM commands run internally by Appium. Mostly an internal feature.                                                                                                                                      |
+| `APPIUM_RELOAD_EXTENSIONS`             | Set this to a truthy value to cause Appium to re-require extensions when new sessions are created. This feature is mostly useful for [building extensions](../../developing/build-drivers.md).                                                          |
+| `APPIUM_TMP_DIR`                       | Set the path to the directory used for temporary files. Same as the `--tmp` command line argument.                                                                                                                                                      |
+
+Appium drivers and plugins may define additional environment variables. The following variables are
+used by official plugins:
+
+| <div style="width:13em">Variable</div> | Plugin    | Description                                                                                                                                                                                                                              |
+| -------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `APPIUM_STORAGE_KEEP_ALL`              | `storage` | Set this to `1`, `true` or `yes` to preserve files in the storage after the server process is terminated. By default, stopping the server process also deletes all files in the storage.                 |
+| `APPIUM_STORAGE_ROOT`                  | `storage` | Set the path to the directory used for storage. If set to an existing folder, all files in it will be retained after terminating the server, unless specified otherwise using `APPIUM_STORAGE_KEEP_ALL`. |

package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/extensions.md

@@ -0,0 +1,240 @@
+---
+title: appium driver/plugin
+---
+
+<style>
+  ul[data-md-component="toc"] .md-nav {
+    display: none;
+  }
+</style>
+
+Provides management options for a specific extension (driver or plugin). Both the `appium driver` and
+`appium plugin` subcommands support the same options.
+
+The following sub-subcommands are supported: `doctor`, `install`, `list`, `run`, `update`,
+and `uninstall`.
+
+## `doctor`
+
+Runs doctor checks for an installed extension, which validate whether the extension has its prerequisites
+configured correctly. Note that not all extensions include doctor checks.
+
+!!! note
+
+    If you maintain an Appium extension and would like to add Appium Doctor support for it, check
+    out the documentation on [Building Doctor Checks](../../developing/build-doctor-checks.md).
+
+#### Usage
+
+```
+appium {driver|plugin} doctor <extension-name>
+```
+
+| Argument         | Description                               |
+| ---------------- | ----------------------------------------- |
+| `extension-name` | The short name of the installed extension |
+
+#### Options
+
+| Argument | Description                      | Type    |
+| -------- | -------------------------------- | ------- |
+| `--json` | Return the result in JSON format | boolean |
+
+#### Example
+
+- Run doctor checks for the UiAutomator2 driver:
+
+    ```
+    appium driver doctor uiautomator2
+    ```
+
+## `install`
+
+Installs an extension.
+
+#### Usage
+
+```
+appium {driver|plugin} install <install-spec>
+```
+
+| <div style="width:7em">Argument</div> | Description                                                                                                                                                                                                                                                       |
+| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `install-spec`                        | The short name of an official extension, with optional `npm` version or tag modifier. If using the `--source` option, the expected format of this argument will change ([see below](#source-vs-install-spec)). |
+
+#### Options
+
+| Argument    | Description                                                                                                                                                                                                                                                                      | Type    |
+| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `--json`    | Return the result in JSON format                                                                                                                                                                                                                                                 | boolean |
+| `--package` | The Node.js package name of the extension. Required if `--source` is set to `git` or `github`.                                                                                                                                   | string  |
+| `--source`  | The location where Appium should look for the given extension. Supported values are `git`, `github`, `local`, or `npm`. Changes the expected format of `install-spec` ([see below](#source-vs-install-spec)). | string  |
+
+#### Source vs Install Spec
+
+| `source` | Format of `<install-spec>`                                                                                                                                              |
+| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| None     | The short name of an official extension, with optional modifiers as supported by `npm install` (e.g. version or tag) |
+| `git`    | The Git URL of the extension                                                                                                                                            |
+| `github` | The GitHub repository URL of the extension                                                                                                                              |
+| `local`  | The local path to the extension containing its `package.json` file                                                                                                      |
+| `npm`    | The name of the `npm` package, with optional modifiers as supported by `npm install` (e.g. version or tag)           |
+
+#### Examples
+
+- Install the latest XCUITest driver:
+
+    ```
+    appium driver install xcuitest
+    ```
+
+- Install the XCUITest driver at version 9.0.0:
+
+    ```
+    appium driver install xcuitest@9.0.0
+    ```
+
+- Install the `beta` version of `@appium/fake-driver` from `npm`:
+
+    ```
+    appium driver install @appium/fake-driver@beta --source=npm
+    ```
+
+- Install a locally-developed plugin:
+
+    ```
+    appium plugin install /path/to/my/plugin --source=local
+    ```
+
+- Install the XCUITest driver from GitHub:
+
+    ```
+    appium driver install https://github.com/appium/appium-xcuitest-driver --source=github --package=appium-xcuitest-driver
+    ```
+
+- Install the XCUITest driver using a Git URL:
+
+    ```
+    appium driver install git://github.com/appium/appium-xcuitest-driver.git --source=git --package=appium-xcuitest-driver
+    ```
+
+## `list`
+
+Lists all installed extensions, plus all official extensions that are not installed.
+
+#### Usage
+
+```
+appium {driver|plugin} list
+```
+
+#### Options
+
+| <div style="width:7em">Argument</div> | Description                                                                                                                                                            | Type    |
+| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `--installed`                         | Only list all installed extensions                                                                                                                                     | boolean |
+| `--json`                              | Return the result in JSON format                                                                                                                                       | boolean |
+| `--updates`                           | List all extensions along with information on whether newer versions are available. Only supported for extensions installed via `npm`. | boolean |
+
+#### Example
+
+- List all installed drivers and check if they have newer versions available:
+
+    ```
+    appium driver list --installed --updates
+    ```
+
+## `run`
+
+Runs an extension script, which can assist with setup or perform other tasks. Note that not all
+extensions include scripts.
+
+#### Usage
+
+```
+appium {driver|plugin} run <extension-name> <script-name> [script-args]
+```
+
+| Argument         | Description                                   |
+| ---------------- | --------------------------------------------- |
+| `extension-name` | The short name of the installed extension     |
+| `script-name`    | The name of the script to be run              |
+| `script-args`    | Any additional arguments passed to the script |
+
+#### Options
+
+| Argument | Description                      | Type    |
+| -------- | -------------------------------- | ------- |
+| `--json` | Return the result in JSON format | boolean |
+
+#### Example
+
+- Run the `reset` script included in the UiAutomator2 driver:
+
+    ```
+    appium driver run uiautomator2 reset
+    ```
+
+## `update`
+
+Updates one or more extensions. Only supported for extensions installed via `npm`. By default,
+Appium will only update minor and patch versions, in order to prevent any breaking changes.
+
+#### Usage
+
+```
+appium {driver|plugin} update <extension-name>
+```
+
+| Argument         | Description                                                                                  |
+| ---------------- | -------------------------------------------------------------------------------------------- |
+| `extension-name` | The short name of the installed extension, or `installed` to update all installed extensions |
+
+#### Options
+
+| Argument   | Description                                                       | Type    |
+| ---------- | ----------------------------------------------------------------- | ------- |
+| `--json`   | Return the result in JSON format                                  | boolean |
+| `--unsafe` | Allow updates of major versions, which may cause breaking changes | boolean |
+
+#### Examples
+
+- Update the UiAutomator2 driver to its latest major version:
+
+    ```
+    appium driver update uiautomator2 --unsafe
+    ```
+
+- Update all installed plugins:
+
+    ```
+    appium plugin update installed
+    ```
+
+## `uninstall`
+
+Removes an installed extension.
+
+#### Usage
+
+```
+appium {driver|plugin} uninstall <extension-name>
+```
+
+| Argument         | Description                               |
+| ---------------- | ----------------------------------------- |
+| `extension-name` | The short name of the installed extension |
+
+#### Options
+
+| Argument | Description                      | Type    |
+| -------- | -------------------------------- | ------- |
+| `--json` | Return the result in JSON format | boolean |
+
+#### Example
+
+- Remove the `images` plugin:
+
+    ```
+    appium plugin uninstall images
+    ```

package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/index.md

@@ -0,0 +1,35 @@
+---
+hide:
+  - toc
+
+title: Command Line Interface
+---
+
+Appium provides a command-line executable (`appium`), which can be used to configure and launch
+the Appium server, as well as manage Appium extensions (drivers and plugins).
+
+The executable has four main subcommands: `server`, `driver`, `plugin`, and `setup`. All subcommands
+(and sub-subcommands) can be run with the `--help`/`-h` option for usage instructions.
+
+<div class="grid cards" markdown>
+
+- [**`appium server`**](./server.md) (or simply `appium`)
+
+  Start an Appium server
+
+- [**`appium driver`**](./extensions.md)
+
+  Manage individual drivers
+
+- [**`appium plugin`**](./extensions.md)
+
+  Manage individual plugins
+
+- [**`appium setup`**](./setup.md)
+
+  Manage multiple drivers/plugins
+
+</div>
+
+Appium also recognizes several [environment variables](./env-vars.md), which may be used for
+advanced configuration.

package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/server.md

@@ -0,0 +1,76 @@
+---
+hide:
+  - toc
+
+title: appium server
+---
+
+Launches an Appium server.
+
+```
+appium server
+```
+
+You can also omit the `server` subcommand:
+
+```
+appium
+```
+
+### Options
+
+!!! note
+
+    All of these options can also be set via a [Configuration File](../../guides/config.md). Options
+    set on the command line will override any options found in a configuration file.
+
+| <div style="width:15em">Argument</div> | Description                                                                                                                                                                                                                                                                                                                                        | Type          | <div style="width:7em">Default</div>                     |
+| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------- |
+| `--address`, `-a`                      | IPv4/IPv6 address to listen on                                                                                                                                                                                                                                                                                                                     | string        | `0.0.0.0`                                                |
+| `--allow-cors`                         | Allow web browser connections from any host                                                                                                                                                                                                                                                                                                        | boolean       | `false`                                                  |
+| `--allow-insecure`                     | List of [insecure features](../../guides/security.md) that should be allowed in this server's sessions. Individual features can be overridden by `--deny-insecure`. Has no effect in combination with `--relaxed-security`.                                                                        | array<string> | `[]`                                                     |
+| `--base-path`, `-pa`                   | Base path to use as the prefix for all webdriver routes running on the server                                                                                                                                                                                                                                                                      | string        | `""`                                                     |
+| `--callback-address`, `-ca`            | Callback IP address                                                                                                                                                                                                                                                                                                                                | string        | `0.0.0.0`                                                |
+| `--callback-port`, `-cp`               | Callback port                                                                                                                                                                                                                                                                                                                                      | integer       | `4723`                                                   |
+| `--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`, `-dc`        | Capabilities that will be used for each session, unless overridden by received capabilities                                                                                                                                                                                                                                                        | object        |                                                          |
+| `--deny-insecure`                      | List of [insecure features](../../guides/security.md) that should be disabled in this server's sessions. Since all insecure features are disabled by default, this argument has no effect without either `--allow-insecure` or `--relaxed-security`, and is applied after both.                                    | array<string> | `[]`                                                     |
+| `--driver`                             | Driver-specific configuration. Keys should correspond to driver package names                                                                                                                                                                                                                                                      | object        |                                                          |
+| `--drivers-import-chunk-size`          | Maximum number of drivers that can be imported in parallel on server startup                                                                                                                                                                                                                                                                       | number        | `3`                                                      |
+| `--keep-alive-timeout`, `-ka`          | Timeout (in seconds) to use as both the keep-alive timeout and the connection timeout for all client requests. Disabled if set to `0`.                                                                                                                                                          | integer       | `600`                                                    |
+| `--request-timeout`                    | Timeout (in seconds) for waiting to receive the entire HTTP request from the client. Disabled if set to `0`. Requests exceeding this timeout will be rejected with the code `HTTP 408`.                                                                                         | integer       | `3600`                                                   |
+| `--local-timezone`                     | Use local timezone for log timestamps                                                                                                                                                                                                                                                                                                              | boolean       | `false`                                                  |
+| `--log`, `-g`                          | Path to a file where the server logs should be output. This does not affect output on the console.                                                                                                                                                                                                                 | string        |                                                          |
+| `--log-filters`                        | List of log filtering rules. See the [log filtering guide](../../guides/log-filters.md) for details.                                                                                                                                                                                                               | array         |                                                          |
+| `--log-level`                          | The log level for the server logs. Supported values are `debug`, `info`, `warn`, or `error`. Combining two supported values using a colon (e.g. `warn:debug`) allows to set separate log levels for the console and file outputs, respectively. | string        | `debug`                                                  |
+| `--log-format`                         | The log format of the server logs. Supported values are `text`, `json`, or `pretty_json`. Setting the value to `json` disables colors.                                                                                                                                                             | string        | `text`                                                   |
+| `--log-no-colors`                      | Disable colors in the server log                                                                                                                                                                                                                                                                                                                   | boolean       | `false`                                                  |
+| `--log-timestamp`                      | Show timestamps in the server log                                                                                                                                                                                                                                                                                                                  | boolean       | `false`                                                  |
+| `--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                                                                                                                                                                                                                                                                                               | boolean       | `false`                                                  |
+| `--nodeconfig`                         | JSON configuration for registering Appium as a node with Selenium Grid 3                                                                                                                                                                                                                                                                           | object        |                                                          |
+| `--plugin`                             | Plugin-specific configuration. Keys should correspond to plugin package names                                                                                                                                                                                                                                                      | object        |                                                          |
+| `--plugins-import-chunk-size`          | Maximum number of plugins that can be imported in parallel on server startup                                                                                                                                                                                                                                                                       | number        | `7`                                                      |
+| `--port`, `-p`                         | Port to listen on                                                                                                                                                                                                                                                                                                                                  | integer       | `4723`                                                   |
+| `--relaxed-security`                   | Allow all [insecure features](../../guides/security.md). Only use this if all clients are in a trusted network and could not potentially break out of the session sandbox. Specific features can be overridden by using `--deny-insecure`.                                                         | boolean       | `false`                                                  |
+| `--session-override`                   | Enable session override (clobbering)                                                                                                                                                                                                                                                                                            | boolean       | `false`                                                  |
+| `--shutdown-timeout`                   | Timeout (in milliseconds) for waiting on all active connections to close, when shutting down the server                                                                                                                                                                                                                         | number        | `5000`                                                   |
+| `--ssl-cert-path`                      | Absolute path to the `.cert` file if TLS is used. Must be provided together with `--ssl-key-path`. See the [SSL/TLS/SPDY Support guide](../../guides/tls.md) for details.                                                                                                                          | string        |                                                          |
+| `--ssl-key-path`                       | Absolute path to the `.key` file if TLS is used. Must be provided together with `--ssl-cert-path`. See the [SSL/TLS/SPDY Support guide](../../guides/tls.md) for details.                                                                                                                          | string        |                                                          |
+| `--strict-caps`                        | Prevent creation of new client sessions that use unsupported capabilities                                                                                                                                                                                                                                                                          | boolean       | `false`                                                  |
+| `--tmp`                                | Absolute path to the directory used for temporary files                                                                                                                                                                                                                                                                                            | string        | [`os.tmpdir()`](https://nodejs.org/api/os.html#ostmpdir) |
+| `--use-drivers`                        | List of drivers to activate. By default, all installed drivers are activated.                                                                                                                                                                                                                                      | array<string> | `[]`                                                     |
+| `--use-plugins`                        | List of plugins to activate. By default, no plugins are activated. Set to `["all"]` to activate all installed plugins.                                                                                                                                                                             | array<string> | `[]`                                                     |
+| `--webhook`, `-G`                      | URL for an HTTP listener where the server logs should be output. This does not affect output on the console.                                                                                                                                                                                                       | string        |                                                          |
+
+### Info Options
+
+The following options are used for reference or debug purposes. They are only supported for the base `appium` command (not `appium server`), and will not launch the server.
+
+| <div style="width:10em">Argument</div> | Description                                                                                                                                  |
+| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--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`, `-v`                      | Print the Appium server version                                                                                                              |

package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/setup.md

@@ -0,0 +1,78 @@
+---
+title: appium setup
+---
+
+<style>
+  ul[data-md-component="toc"] .md-nav {
+    display: none;
+  }
+</style>
+
+Installs a specific preset of extensions (drivers and plugins), or uninstalls all extensions.
+When installing a preset, any already installed extensions are kept intact.
+
+The following sub-subcommands are supported: `browser`, `desktop`, `mobile`, and `reset`.
+
+Refer to the [Ecosystem documentation](../../ecosystem/index.md) to learn more about the extensions
+mentioned below.
+
+## `browser`
+
+Installs the following extensions for browser webview testing:
+
+- Drivers: `safari`[^1], `gecko`, `chromium`
+- Plugins: `images`, `inspector`
+
+#### Usage
+
+```
+appium setup browser
+```
+
+## `desktop`
+
+Installs the following extensions for desktop application testing:
+
+- Drivers: `mac2`[^1], `windows`[^2]
+- Plugins: `images`, `inspector`
+
+#### Usage
+
+```
+appium setup desktop
+```
+
+## `mobile`
+
+Installs the following extensions for mobile testing:
+
+- Drivers: `uiautomator2`, `xcuitest`[^1], `espresso`
+- Plugins: `images`, `inspector`
+
+#### Usage
+
+```
+appium setup mobile
+```
+
+You can also omit the `mobile` sub-subcommand:
+
+```
+appium setup
+```
+
+## `reset`
+
+Uninstalls all installed extensions, along with their manifest files, from the Appium home
+directory. This can be useful if you experience configuration issues on server startup, for
+example, due to a failed upgrade attempt from an older Appium version.
+
+#### Usage
+
+```
+appium setup reset
+```
+
+[^1]: Only installed if the host machine is running macOS.
+
+[^2]: Only installed if the host machine is running Windows.

package/src/resources/submodules/appium/packages/appium/docs/zh/reference/index.md

@@ -0,0 +1,25 @@
+---
+hide:
+  - toc
+
+title: Reference
+---
+
+This section of the Appium documentation provides a reference to the two main interfaces within the
+Appium server: the command-line executable, and the supported API endpoints.
+
+<div class="grid cards" markdown>
+
+- :octicons-command-palette-16: [**Command Line Interface**](./cli/index.md)
+
+  ---
+
+  Learn how to use the Appium command-line executable
+
+- :material-cloud-braces: [**API Endpoints**](./api/index.md)
+
+  ---
+
+  View endpoints supported by the Appium server
+
+</div>

package/src/resources/submodules/appium/packages/appium/docs/zh/resources/index.md

@@ -0,0 +1,28 @@
+---
+hide:
+  - navigation
+  - toc
+
+title: Additional Resources
+---
+
+Here you can find links to additional Appium resources around the web:
+
+## Websites
+
+- [Appium Pro](https://appiumpro.com) - a blog and newsletter written by one of Appium's
+  maintainers, Jonathan Lipps, with lots of useful guides
+
+## Online Courses
+
+- [Appium and Selenium Fundamentals](https://ui.headspin.io/university/learn/appium-selenium-fundamentals-2020) - a comprehensive video course on learning Python, Selenium, and Appium by Jonathan Lipps
+- [Mobile Test Automation with Appium](https://testautomationu.applitools.com/appium-java-tutorial/) - a video course by Moataz Nabil
+- [Advanced Appium](https://www.linkedin.com/learning/advanced-appium) - a video course by Jonathan Lipps
+
+## Conference Archives
+
+- [AppiumConf 2018](https://www.youtube.com/playlist?list=PLhr2WKNPXcZOmOf1k2aqkbMZwnZb2pSZL)
+- [AppiumConf 2019](https://www.youtube.com/playlist?list=PL9Z-JgiTsOYSfJh9YKI9Stj3FMwHERw6w)
+- [AppiumConf 2021](https://www.youtube.com/playlist?list=PL9Z-JgiTsOYRCcJhDfmKAah9XmAp2b903)
+- [AppiumConf 2024](https://www.youtube.com/playlist?list=PL9Z-JgiTsOYQaU5i5LJtAWlh5WVZPi3If)
+- [SeleniumConf & AppiumConf 2025](https://www.youtube.com/playlist?list=PLRdSclUtJDYV2R92TLbmwxws6clruuTjH)

package/src/resources/submodules/appium/packages/appium/docs/zh/sponsors/index.md

@@ -0,0 +1,61 @@
+---
+hide:
+  - navigation
+  - toc
+
+title: Sponsors & Backers
+---
+
+<style>
+  .appium-sponsor-thanks { display: none; }
+  .sponsor-section img { height: 64px; padding-right: 1em; }
+</style>
+
+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.
+
+## 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!
+
+## 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">
+  <img src="/docs/en/latest/assets/images/sponsor-logo-browserstack-dark.png#only-dark" width="250" alt="BrowserStack" />
+  <img src="/docs/en/latest/assets/images/sponsor-logo-browserstack-light.png#only-light" width="250" alt="BrowserStack" />
+</a>
+
+<a href="https://lambdatest.com/?utm_source=appium.io&utm_medium=organic&utm_campaign=june_25&utm_term=sk&utm_content=webpage">
+  <img src="/docs/en/latest/assets/images/sponsor-logo-lambdatest-dark.png#only-dark" width="250" alt="LambdaTest" />
+  <img src="/docs/en/latest/assets/images/sponsor-logo-lambdatest-light.png#only-light" width="250" alt="LambdaTest" />
+</a>
+
+## Gold Sponsors
+
+<div class="sponsor-section"><a href="https://jetify.com/" target="_blank"><img src="https://images.opencollective.com/jetify/415824c/avatar/64.png" alt="Jetify" /></a>
+</div>
+
+[Become a Gold Sponsor](https://opencollective.com/appium/contribute/gold-sponsor-72877/checkout?interval=month&amount=500&contributeAs=me)
+
+## Silver Sponsors
+
+<div class="sponsor-section"><a href="https://magicpod.com/" target="_blank"><img src="https://images.opencollective.com/magicpod/722b7e4/avatar/64.png" alt="MagicPod" /></a>
+</div>
+
+[Become a Silver Sponsor](https://opencollective.com/appium/contribute/silver-sponsor-72876/checkout?interval=month&amount=250&contributeAs=me)
+
+## Bronze Sponsors
+
+<div class="sponsor-section"><a href="https://route4me.com/" target="_blank"><img src="https://images.opencollective.com/route4me/71fb6fa/avatar/64.png" alt="Route4Me" /></a>
+  <a href="https://webdriver.io/" target="_blank"><img src="https://images.opencollective.com/webdriverio/bbdd6c3/avatar/64.png" alt="WebdriverIO" /></a>
+</div>
+
+[Become a Bronze Sponsor](https://opencollective.com/appium/contribute/sponsors-70690/checkout?interval=month&amount=100&contributeAs=me)

package/src/resources/submodules/appium/packages/appium/types/manifest/README.md

@@ -0,0 +1,30 @@
+# appium-manifest types
+
+This dir contains versioned type declarations for our manifest file (`extensions.yaml`).
+
+## About
+
+Originally, the manifest file was versioned; it had a `schemaRev` prop.  Eventually, the requirement for this prop was dropped, and became optional.  As of this writing, it is now required again.  
+
+The idea was that if Appium found an `extensions.yaml` with a `schemaRev` lower than its "current" revision, it would "migrate" the file to the current revision.  When we removed the requirement for the `schemaRev` prop, we removed this logic.
+
+As of _v3_ of the schema, we are reinstating versioning and migrations.
+
+## How To Add A New Version
+
+The manifest file types—and thus its format—is composed of types used elsewhere in our codebase.  This is probably a design flaw, but the fact remains that the manifest file's format is strongly coupled to Appium's extension-handling logic.
+
+For that reason, it is _non-trivial_ to reuse the types declared by older revisions to declare a new revision.  If and when someone de-couples the types from the schema, we will have to use the _copy-and-paste_ strategy to create a new version.
+
+1. The current version of the schema is defined in `constants.js` as `CURRENT_SCHEMA_REV`.  **Increment** this value.
+2. **Copy** the `.ts` file in this directory corresponding to the (now old) current version of the schema into a new file named `v<new-version>.ts`.  For example, if the current version is `3`, and you're creating `4`, then you would copy `v3.ts` to `v4.ts`.
+3. **Modify** your new file to do whatever it is you need to do with it.  Do _not_ build types upon old versions of the schema.
+4. **Modify** `index.ts`:
+   1. **Append** `import * as ManifestV<new-version> from './v<new-version>'`
+   2. **Replace** `export * from './v<current-version>'` with `export * from './v<new-version>'`
+   3. **Append** `ManifestV<new-version>` to the `export {ManifestV...}` line.
+   4. **Append** a key/value pair to `ManifestDataVersions` with the new _numeric_ version number as the key and the value `ManifestV<new-version>.ManifestData`.
+5. **Create** a new `const SCHEMA_REV_<new-version> = <new-version>` in `manifest-migrations.js`.
+6. Finally, **append** a new key/value pair to the `Migrations` object in `manifest-migrations.js`.  The key should be a reference to the constant created in step 5, and the value should be a function which  performs the migration from the (old) current version to the new version.
+
+-- @boneskull, Nov 8 2022