@appium/mcp-documentation 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -0
- package/package.json +3 -6
- package/src/resources/submodules/appium/.github/PULL_REQUEST_TEMPLATE.md +28 -0
- package/src/resources/submodules/appium/.github/copilot-instructions.md +9 -0
- package/src/resources/submodules/appium/CHANGELOG.md +45 -0
- package/src/resources/submodules/appium/GOVERNANCE.md +189 -0
- package/src/resources/submodules/appium/README.md +221 -0
- package/src/resources/submodules/appium/ROADMAP.md +30 -0
- package/src/resources/submodules/appium/SPONSORS.md +3 -0
- package/src/resources/submodules/appium/docs/README.md +6 -0
- package/src/resources/submodules/appium/docs/payout.md +35 -0
- package/src/resources/submodules/appium/packages/appium/CHANGELOG.md +1547 -0
- package/src/resources/submodules/appium/packages/appium/README.md +221 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/index.md +2 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-appiumconf2024.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-browserstack-as-strategic-partner.md +46 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-headspin-as-development-partner.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-lambdatest-as-development-partner.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-lambdatest-as-strategic-partner.md +42 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-sauce-labs-as-strategic-partner.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-sponsorship-program.md +48 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/appium3.md +40 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/hello-world.md +15 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/contributing/index.md +150 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-docs.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-doctor-checks.md +141 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-drivers.md +1002 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-plugins.md +523 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/config-system.md +451 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/index.md +18 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/sensitive.md +49 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/clients.md +132 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/drivers.md +207 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/index.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/plugins.md +138 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/tools.md +106 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/branch-testing.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/caching.md +76 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/caps.md +271 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/config.md +98 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/context.md +44 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/event-timing.md +73 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/execute-methods.md +122 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/grid.md +178 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/headers.md +17 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/log-filters.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/managing-exts.md +87 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/migrating-1-to-2.md +368 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/migrating-2-to-3.md +464 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/security.md +87 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/settings.md +68 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/tls.md +42 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/index.md +59 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/appium.md +202 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/clients.md +127 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/drivers.md +188 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/history.md +196 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/index.md +39 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/index.md +29 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/install.md +50 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/next-steps.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/requirements.md +29 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-dotnet.md +105 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-java.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-js.md +75 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-py.md +60 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-rb.md +83 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/uiauto2-driver.md +144 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/appium.md +394 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/bidi.md +70 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/index.md +30 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/jsonwp.md +214 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/mjsonwp.md +151 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/others.md +736 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/plugins.md +289 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/webdriver.md +1114 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/env-vars.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/extensions.md +246 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/index.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/insecure-features.md +24 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/server.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/setup.md +76 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/index.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/session/caps.md +56 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/session/index.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/resources/index.md +28 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/sponsors/index.md +69 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/index.md +2 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-appiumconf2024.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-browserstack-as-strategic-partner.md +46 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-headspin-as-development-partner.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-lambdatest-as-development-partner.md +34 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-lambdatest-as-strategic-partner.md +41 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-sauce-labs-as-strategic-partner.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-sponsorship-program.md +48 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/appium3.md +40 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/hello-world.md +15 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/contributing/index.md +158 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-docs.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-doctor-checks.md +141 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-drivers.md +1010 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-plugins.md +529 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/config-system.md +468 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/index.md +18 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/sensitive.md +49 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/clients.md +143 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/drivers.md +219 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/index.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/plugins.md +140 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/tools.md +115 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/branch-testing.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/caching.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/caps.md +276 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/config.md +102 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/context.md +44 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/event-timing.md +75 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/execute-methods.md +142 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/grid.md +178 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/headers.md +17 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/log-filters.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/managing-exts.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/migrating-1-to-2.md +402 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/migrating-2-to-3.md +458 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/security.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/settings.md +70 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/tls.md +43 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/index.md +55 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/appium.md +191 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/clients.md +139 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/drivers.md +188 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/history.md +196 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/index.md +39 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/index.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/install.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/next-steps.md +19 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/requirements.md +29 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-dotnet.md +107 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-java.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-js.md +77 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-py.md +63 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-rb.md +85 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/uiauto2-driver.md +148 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/appium.md +395 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/bidi.md +71 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/index.md +30 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/jsonwp.md +215 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/mjsonwp.md +152 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/others.md +737 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/plugins.md +291 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/webdriver.md +1114 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/env-vars.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/extensions.md +247 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/index.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/insecure-features.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/server.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/setup.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/index.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/session/caps.md +56 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/session/index.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/resources/index.md +28 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/sponsors/index.md +66 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo-horiz-white.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo-horiz.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo-white.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-light.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-lambdatest-dark.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-lambdatest-light.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-sauce.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-testmuai-dark.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-testmuai-light.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/index.md +2 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-appiumconf2024.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-browserstack-as-strategic-partner.md +46 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-headspin-as-development-partner.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-lambdatest-as-development-partner.md +34 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-lambdatest-as-strategic-partner.md +41 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-sauce-labs-as-strategic-partner.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-sponsorship-program.md +48 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/appium3.md +40 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/hello-world.md +15 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/contributing/index.md +132 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-docs.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-doctor-checks.md +141 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-drivers.md +1010 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-plugins.md +529 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/config-system.md +468 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/index.md +18 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/sensitive.md +49 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/clients.md +143 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/drivers.md +219 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/index.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/plugins.md +140 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/tools.md +115 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/branch-testing.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/caching.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/caps.md +279 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/config.md +102 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/context.md +44 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/event-timing.md +75 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/execute-methods.md +142 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/grid.md +178 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/headers.md +17 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/log-filters.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/managing-exts.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/migrating-1-to-2.md +410 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/migrating-2-to-3.md +459 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/security.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/settings.md +70 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/tls.md +43 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/index.md +54 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/appium.md +91 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/clients.md +100 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/drivers.md +101 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/history.md +72 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/index.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/index.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/install.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/next-steps.md +19 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/requirements.md +21 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-dotnet.md +99 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-java.md +20 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-js.md +62 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-py.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-rb.md +80 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/uiauto2-driver.md +119 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/appium.md +395 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/bidi.md +71 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/index.md +30 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/jsonwp.md +215 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/mjsonwp.md +152 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/others.md +737 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/plugins.md +291 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/webdriver.md +1114 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/env-vars.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/extensions.md +247 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/index.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/insecure-features.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/server.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/setup.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/index.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/session/caps.md +56 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/session/index.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/resources/index.md +28 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/sponsors/index.md +66 -0
- package/src/resources/submodules/appium/packages/appium/types/manifest/README.md +30 -0
- package/src/resources/submodules/appium/packages/base-driver/CHANGELOG.md +1244 -0
- package/src/resources/submodules/appium/packages/base-driver/README.md +15 -0
- package/src/resources/submodules/appium/packages/base-driver/docs/mjsonwp/errors.md +82 -0
- package/src/resources/submodules/appium/packages/base-driver/docs/mjsonwp/protocol-methods.md +182 -0
- package/src/resources/submodules/appium/packages/base-driver/static/appium.png +0 -0
- package/src/resources/submodules/appium/packages/base-plugin/CHANGELOG.md +764 -0
- package/src/resources/submodules/appium/packages/base-plugin/README.md +15 -0
- package/src/resources/submodules/appium/packages/docutils/CHANGELOG.md +1038 -0
- package/src/resources/submodules/appium/packages/docutils/README.md +27 -0
- package/src/resources/submodules/appium/packages/driver-test-support/CHANGELOG.md +790 -0
- package/src/resources/submodules/appium/packages/driver-test-support/README.md +103 -0
- package/src/resources/submodules/appium/packages/eslint-config-appium-ts/CHANGELOG.md +256 -0
- package/src/resources/submodules/appium/packages/eslint-config-appium-ts/README.md +47 -0
- package/src/resources/submodules/appium/packages/execute-driver-plugin/CHANGELOG.md +671 -0
- package/src/resources/submodules/appium/packages/execute-driver-plugin/README.md +55 -0
- package/src/resources/submodules/appium/packages/fake-driver/CHANGELOG.md +603 -0
- package/src/resources/submodules/appium/packages/fake-driver/README.md +7 -0
- package/src/resources/submodules/appium/packages/fake-driver/lib/screen.png +0 -0
- package/src/resources/submodules/appium/packages/fake-plugin/CHANGELOG.md +780 -0
- package/src/resources/submodules/appium/packages/fake-plugin/README.md +7 -0
- package/src/resources/submodules/appium/packages/images-plugin/CHANGELOG.md +691 -0
- package/src/resources/submodules/appium/packages/images-plugin/README.md +27 -0
- package/src/resources/submodules/appium/packages/images-plugin/docs/find-by-image.md +65 -0
- package/src/resources/submodules/appium/packages/images-plugin/docs/image-comparison.md +203 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/appstore.png +0 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/img1.png +0 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/img2.png +0 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/img2_part.png +0 -0
- package/src/resources/submodules/appium/packages/logger/CHANGELOG.md +212 -0
- package/src/resources/submodules/appium/packages/logger/README.md +31 -0
- package/src/resources/submodules/appium/packages/opencv/CHANGELOG.md +446 -0
- package/src/resources/submodules/appium/packages/opencv/README.md +68 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/appium-diagram.jpg +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/cc1.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/cc2.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/cc_rotated.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/findwaldo.jpg +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/number5.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/waldo.jpg +0 -0
- package/src/resources/submodules/appium/packages/plugin-test-support/CHANGELOG.md +610 -0
- package/src/resources/submodules/appium/packages/plugin-test-support/README.md +49 -0
- package/src/resources/submodules/appium/packages/relaxed-caps-plugin/CHANGELOG.md +209 -0
- package/src/resources/submodules/appium/packages/relaxed-caps-plugin/README.md +35 -0
- package/src/resources/submodules/appium/packages/schema/CHANGELOG.md +308 -0
- package/src/resources/submodules/appium/packages/schema/README.md +50 -0
- package/src/resources/submodules/appium/packages/storage-plugin/CHANGELOG.md +157 -0
- package/src/resources/submodules/appium/packages/storage-plugin/README.md +83 -0
- package/src/resources/submodules/appium/packages/strongbox/CHANGELOG.md +129 -0
- package/src/resources/submodules/appium/packages/strongbox/README.md +110 -0
- package/src/resources/submodules/appium/packages/support/CHANGELOG.md +1147 -0
- package/src/resources/submodules/appium/packages/support/README.md +161 -0
- package/src/resources/submodules/appium/packages/tsconfig/CHANGELOG.md +147 -0
- package/src/resources/submodules/appium/packages/tsconfig/README.md +19 -0
- package/src/resources/submodules/appium/packages/types/CHANGELOG.md +871 -0
- package/src/resources/submodules/appium/packages/types/README.md +21 -0
- package/src/resources/submodules/appium/packages/universal-xml-plugin/CHANGELOG.md +502 -0
- package/src/resources/submodules/appium/packages/universal-xml-plugin/README.md +53 -0
- package/src/resources/submodules/appium/renovate/README.md +55 -0
- package/src/resources/submodules/appium-skills/.github/dependabot.yml +11 -0
- package/src/resources/submodules/appium-skills/.github/workflows/pr-title.yml +10 -0
- package/src/resources/submodules/appium-skills/AGENTS.md +214 -0
- package/src/resources/submodules/appium-skills/LICENSE +201 -0
- package/src/resources/submodules/appium-skills/README.md +33 -0
- package/src/resources/submodules/appium-skills/skills/appium-troubleshooting/SKILL.md +66 -0
- package/src/resources/submodules/appium-skills/skills/appium-troubleshooting/references/community-search.md +51 -0
- package/src/resources/submodules/appium-skills/skills/appium-troubleshooting/references/uiautomator2-locators.md +34 -0
- package/src/resources/submodules/appium-skills/skills/appium-troubleshooting/references/uiautomator2-session-startup.md +53 -0
- package/src/resources/submodules/appium-skills/skills/appium-troubleshooting/references/xcuitest-element-lookup.md +23 -0
- package/src/resources/submodules/appium-skills/skills/appium-troubleshooting/references/xcuitest-locators.md +16 -0
- package/src/resources/submodules/appium-skills/skills/appium-troubleshooting/references/xcuitest-troubleshooting.md +52 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-android/SKILL.md +346 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-bundletool/SKILL.md +91 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-chromium/SKILL.md +260 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-espresso/SKILL.md +216 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-ffmpeg/SKILL.md +91 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-node/SKILL.md +128 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-uiautomator2/SKILL.md +225 -0
- package/src/resources/submodules/appium-skills/skills/environment-setup-xcuitest/SKILL.md +153 -0
- package/src/resources/submodules/appium-skills/skills/xcuitest-real-device-config/SKILL.md +488 -0
- package/src/resources/submodules/appium-uiautomator2-driver/CHANGELOG.md +1506 -0
- package/src/resources/submodules/appium-uiautomator2-driver/README.md +2253 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/actions.md +72 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/activity-startup.md +47 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/android-appbundle.md +69 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/android-mobile-gestures.md +352 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/android-multiwindow.md +872 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/architecture.md +34 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/bidi.md +50 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/capability-sets.md +136 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/mjpeg.md +111 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/scheduled-actions.md +155 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/uiautomator-uiselector.md +51 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/unlock/main.md +95 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/unlock/screen1.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/unlock/screen2.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/test/functional/assets/checkered-squares.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/test/functional/assets/start-button.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/test/functional/assets/stop-button.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/.github/ISSUE_TEMPLATE.md +4 -0
- package/src/resources/submodules/appium-xcuitest-driver/CHANGELOG.md +3373 -0
- package/src/resources/submodules/appium-xcuitest-driver/README.md +55 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/assets/images/appium-logo-white.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/assets/images/appium-logo.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/assets/images/appium-plus-xctest.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/contributing.md +45 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/endpoints-wda.md +61 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/endpoints.md +95 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/device-setup.md +81 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/index.md +36 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/installation.md +38 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/check-prov-prof.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/create-new-project.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/create-single-page.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/no-prov-prof.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/project-prov-prof.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/set-up-bundle.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/untrusted-dev.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/xcode-bundle-id.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/xcode-config.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/xcode-facebook-fail.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/assets/images/xcode-facebook-succeed.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/auto-config.md +54 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/basic-manual-config.md +40 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/full-manual-config.md +49 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/generic-device-config.md +75 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/provisioning-profile/index.md +117 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/getting-started/system-requirements.md +131 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/assets/images/ios-xctest-file-movement/keynote.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/assets/images/ios-xctest-file-movement/on_my_iphone.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/assets/images/ios-xctest-file-movement/top_files.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/attach-to-running-wda.md +43 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/audio-capture.md +78 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/biometric-auth.md +29 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/capability-sets.md +169 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/ci-setup.md +47 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/clipboard.md +47 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/file-transfer.md +147 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/gestures.md +55 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/hybrid.md +137 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/input-events.md +67 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/install-certificate.md +20 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/mjpeg.md +98 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/multiple-xcode-versions.md +37 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/parallel-tests.md +39 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/remotexpc-tunnels-real-devices.md +148 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/run-prebuilt-wda.md +147 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/run-preinstalled-wda.md +177 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/tvos.md +246 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/wda-custom-server.md +283 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/index.md +36 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/overview.md +137 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/assets/images/useXctestrunFile.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/bidi.md +192 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/capabilities.md +164 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/commands.md +468 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/element-attributes.md +157 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/env-vars.md +18 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/execute-methods.md +2269 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/ios-predicate.md +196 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/locator-strategies.md +107 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/scripts.md +555 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/security-flags.md +28 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/server-args.md +19 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/settings.md +467 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/xpath-extensions.md +167 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/troubleshooting/element-lookup.md +202 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/troubleshooting/index.md +204 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/troubleshooting/wda-slowness.md +206 -0
- package/src/resources/submodules/appium-xcuitest-driver/test/assets/test.png +0 -0
- package/src/resources/submodules.zip +0 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- toc
|
|
4
|
+
|
|
5
|
+
title: Environment Variables
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
The primary ways of configuring the Appium server are via [Command-Line Arguments](./server.md) or
|
|
9
|
+
the [Config File](../../guides/config.md). However, some more advanced features are toggled or
|
|
10
|
+
configured via environment variables. To set environment variables, refer to the documentation for
|
|
11
|
+
your operating system and terminal.
|
|
12
|
+
|
|
13
|
+
These are the environment variables that the Appium server understands:
|
|
14
|
+
|
|
15
|
+
|<div style="width:18em">Variable</div>|Description|
|
|
16
|
+
|--------|-----------|
|
|
17
|
+
|`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.|
|
|
18
|
+
|`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)|
|
|
19
|
+
|`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`|
|
|
20
|
+
|`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|
|
|
21
|
+
|`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.|
|
|
22
|
+
|`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).|
|
|
23
|
+
|`APPIUM_TMP_DIR`|Set the path to the directory used for temporary files. Same as the `--tmp` command line argument.|
|
|
24
|
+
|
|
25
|
+
Appium drivers and plugins may define additional environment variables. The following variables are
|
|
26
|
+
used by official plugins:
|
|
27
|
+
|
|
28
|
+
|<div style="width:13em">Variable</div>|Plugin|Description|
|
|
29
|
+
|--------|-----------|-----------|
|
|
30
|
+
|`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.|
|
|
31
|
+
|`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`.|
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: appium driver/plugin
|
|
3
|
+
---
|
|
4
|
+
<style>
|
|
5
|
+
ul[data-md-component="toc"] .md-nav {
|
|
6
|
+
display: none;
|
|
7
|
+
}
|
|
8
|
+
</style>
|
|
9
|
+
|
|
10
|
+
Provides management options for a specific extension (driver or plugin). Both the `appium driver` and
|
|
11
|
+
`appium plugin` subcommands support the same options.
|
|
12
|
+
|
|
13
|
+
The following sub-subcommands are supported: `doctor`, `install`, `list`, `run`, `update`,
|
|
14
|
+
and `uninstall`.
|
|
15
|
+
|
|
16
|
+
## `doctor`
|
|
17
|
+
|
|
18
|
+
Runs doctor checks for an installed extension, which validate whether the extension has its prerequisites
|
|
19
|
+
configured correctly. Note that not all extensions include doctor checks.
|
|
20
|
+
|
|
21
|
+
!!! note
|
|
22
|
+
|
|
23
|
+
If you maintain an Appium extension and would like to add Appium Doctor support for it, check
|
|
24
|
+
out the documentation on [Building Doctor Checks](../../developing/build-doctor-checks.md).
|
|
25
|
+
|
|
26
|
+
#### Usage
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
appium {driver|plugin} doctor <extension-name>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
|Argument|Description|
|
|
33
|
+
|--|--|
|
|
34
|
+
|`extension-name`|The short name of the installed extension|
|
|
35
|
+
|
|
36
|
+
#### Options
|
|
37
|
+
|
|
38
|
+
|Argument|Description|Type|
|
|
39
|
+
|--|--|--|
|
|
40
|
+
|`--json`|Return the result in JSON format|boolean|
|
|
41
|
+
|
|
42
|
+
#### Example
|
|
43
|
+
|
|
44
|
+
- Run doctor checks for the UiAutomator2 driver:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
appium driver doctor uiautomator2
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## `install`
|
|
51
|
+
|
|
52
|
+
Installs an extension.
|
|
53
|
+
|
|
54
|
+
#### Usage
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
appium {driver|plugin} install <install-spec>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
|<div style="width:7em">Argument</div>|Description|
|
|
61
|
+
|--|--|
|
|
62
|
+
|`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)).|
|
|
63
|
+
|
|
64
|
+
#### Options
|
|
65
|
+
|
|
66
|
+
|Argument|Description|Type|
|
|
67
|
+
|--|--|--|
|
|
68
|
+
|`--json`|Return the result in JSON format|boolean|
|
|
69
|
+
|`--package`|The Node.js package name of the extension. Required if `--source` is set to `git` or `github`.|string|
|
|
70
|
+
|`--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|
|
|
71
|
+
|
|
72
|
+
#### Source vs Install Spec
|
|
73
|
+
|
|
74
|
+
|`source`|Format of `<install-spec>`|
|
|
75
|
+
|--|--|
|
|
76
|
+
|None|The short name of an official extension, with optional modifiers as supported by `npm install` (e.g. version or tag)|
|
|
77
|
+
|`git`|The Git URL of the extension|
|
|
78
|
+
|`github`|The GitHub repository URL of the extension|
|
|
79
|
+
|`local`|The local path to the extension containing its `package.json` file|
|
|
80
|
+
|`npm`|The name of the `npm` package, with optional modifiers as supported by `npm install` (e.g. version or tag)|
|
|
81
|
+
|
|
82
|
+
#### Examples
|
|
83
|
+
|
|
84
|
+
- Install the latest XCUITest driver:
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
appium driver install xcuitest
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
- Install the XCUITest driver at version 9.0.0:
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
appium driver install xcuitest@9.0.0
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
- Install the `beta` version of `@appium/fake-driver` from `npm`:
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
appium driver install @appium/fake-driver@beta --source=npm
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
- Install a locally-developed plugin:
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
appium plugin install /path/to/my/plugin --source=local
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
- Install the XCUITest driver from GitHub:
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
appium driver install https://github.com/appium/appium-xcuitest-driver --source=github --package=appium-xcuitest-driver
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
- Install the XCUITest driver using a Git URL:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
appium driver install git://github.com/appium/appium-xcuitest-driver.git --source=git --package=appium-xcuitest-driver
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
- Install a branch of XCUITest driver repository using a Git URL:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
appium driver install git://github.com/appium/appium-xcuitest-driver.git#specific-branch --source=git --package=appium-xcuitest-driver
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## `list`
|
|
127
|
+
|
|
128
|
+
Lists all installed extensions, plus all official extensions that are not installed.
|
|
129
|
+
|
|
130
|
+
#### Usage
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
appium {driver|plugin} list
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
#### Options
|
|
137
|
+
|
|
138
|
+
|<div style="width:7em">Argument</div>|Description|Type|
|
|
139
|
+
|--|--|--|
|
|
140
|
+
|`--installed`|Only list all installed extensions|boolean|
|
|
141
|
+
|`--json`|Return the result in JSON format|boolean|
|
|
142
|
+
|`--updates`|List all extensions along with information on whether newer versions are available. Only supported for extensions installed via `npm`.|boolean|
|
|
143
|
+
|`--verbose`|Show additional details for each extension|boolean|
|
|
144
|
+
|
|
145
|
+
#### Example
|
|
146
|
+
|
|
147
|
+
- List all installed drivers and check if they have newer versions available:
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
appium driver list --installed --updates
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## `run`
|
|
154
|
+
|
|
155
|
+
Runs an extension script, which can assist with setup or perform other tasks. Note that not all
|
|
156
|
+
extensions include scripts.
|
|
157
|
+
|
|
158
|
+
#### Usage
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
appium {driver|plugin} run <extension-name> <script-name> [script-args]
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
|Argument|Description|
|
|
165
|
+
|--|--|
|
|
166
|
+
|`extension-name`|The short name of the installed extension|
|
|
167
|
+
|`script-name`|The name of the script to be run|
|
|
168
|
+
|`script-args`|Any additional arguments passed to the script|
|
|
169
|
+
|
|
170
|
+
#### Options
|
|
171
|
+
|
|
172
|
+
|Argument|Description|Type|
|
|
173
|
+
|--|--|--|
|
|
174
|
+
|`--json`|Return the result in JSON format|boolean|
|
|
175
|
+
|
|
176
|
+
#### Example
|
|
177
|
+
|
|
178
|
+
- Run the `reset` script included in the UiAutomator2 driver:
|
|
179
|
+
|
|
180
|
+
```
|
|
181
|
+
appium driver run uiautomator2 reset
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
## `update`
|
|
185
|
+
|
|
186
|
+
Updates one or more extensions. Only supported for extensions installed via `npm`. By default,
|
|
187
|
+
Appium will only update minor and patch versions, in order to prevent any breaking changes.
|
|
188
|
+
|
|
189
|
+
#### Usage
|
|
190
|
+
|
|
191
|
+
```
|
|
192
|
+
appium {driver|plugin} update <extension-name>
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
|Argument|Description|
|
|
196
|
+
|--|--|
|
|
197
|
+
|`extension-name`|The short name of the installed extension, or `installed` to update all installed extensions|
|
|
198
|
+
|
|
199
|
+
#### Options
|
|
200
|
+
|
|
201
|
+
|Argument|Description|Type|
|
|
202
|
+
|--|--|--|
|
|
203
|
+
|`--json`|Return the result in JSON format|boolean|
|
|
204
|
+
|`--unsafe`|Allow updates of major versions, which may cause breaking changes|boolean|
|
|
205
|
+
|
|
206
|
+
#### Examples
|
|
207
|
+
|
|
208
|
+
- Update the UiAutomator2 driver to its latest major version:
|
|
209
|
+
|
|
210
|
+
```
|
|
211
|
+
appium driver update uiautomator2 --unsafe
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
- Update all installed plugins:
|
|
215
|
+
|
|
216
|
+
```
|
|
217
|
+
appium plugin update installed
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
## `uninstall`
|
|
221
|
+
|
|
222
|
+
Removes an installed extension.
|
|
223
|
+
|
|
224
|
+
#### Usage
|
|
225
|
+
|
|
226
|
+
```
|
|
227
|
+
appium {driver|plugin} uninstall <extension-name>
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
|Argument|Description|
|
|
231
|
+
|--|--|
|
|
232
|
+
|`extension-name`|The short name of the installed extension|
|
|
233
|
+
|
|
234
|
+
#### Options
|
|
235
|
+
|
|
236
|
+
|Argument|Description|Type|
|
|
237
|
+
|--|--|--|
|
|
238
|
+
|`--json`|Return the result in JSON format|boolean|
|
|
239
|
+
|
|
240
|
+
#### Example
|
|
241
|
+
|
|
242
|
+
- Remove the `images` plugin:
|
|
243
|
+
|
|
244
|
+
```
|
|
245
|
+
appium plugin uninstall images
|
|
246
|
+
```
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- toc
|
|
4
|
+
|
|
5
|
+
title: Command Line Interface
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Appium provides a command-line executable (`appium`), which can be used to configure and launch
|
|
9
|
+
the Appium server, as well as manage Appium extensions (drivers and plugins).
|
|
10
|
+
|
|
11
|
+
The executable has four main subcommands: `server`, `driver`, `plugin`, and `setup`. All subcommands
|
|
12
|
+
(and sub-subcommands) can be run with the `--help`/`-h` option for usage instructions.
|
|
13
|
+
|
|
14
|
+
<div class="grid cards" markdown>
|
|
15
|
+
|
|
16
|
+
- [__`appium server`__](./server.md) (or simply `appium`)
|
|
17
|
+
|
|
18
|
+
Start an Appium server
|
|
19
|
+
|
|
20
|
+
- [__`appium driver`__](./extensions.md)
|
|
21
|
+
|
|
22
|
+
Manage individual drivers
|
|
23
|
+
|
|
24
|
+
- [__`appium plugin`__](./extensions.md)
|
|
25
|
+
|
|
26
|
+
Manage individual plugins
|
|
27
|
+
|
|
28
|
+
- [__`appium setup`__](./setup.md)
|
|
29
|
+
|
|
30
|
+
Manage multiple drivers/plugins
|
|
31
|
+
|
|
32
|
+
</div>
|
|
33
|
+
|
|
34
|
+
The Appium server also recognizes several [environment variables](./env-vars.md) and
|
|
35
|
+
[insecure feature names](./insecure-features.md), though drivers and plugins can also define
|
|
36
|
+
variables and features of their own.
|
package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/insecure-features.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- toc
|
|
4
|
+
|
|
5
|
+
title: Insecure Features
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
The Appium server implements [a security protection mechanism](../../guides/security.md) that
|
|
9
|
+
allows the management of various insecure features.
|
|
10
|
+
|
|
11
|
+
The following features are defined on the server level and can be used even without drivers, but
|
|
12
|
+
they can only be enabled using the wildcard (`*`) prefix:
|
|
13
|
+
|
|
14
|
+
| Feature Name | Description |
|
|
15
|
+
|-------------------|-------------------------------------------------------------------------------|
|
|
16
|
+
|`session_discovery`|Allows retrieving the list of active server sessions via `GET /appium/sessions`|
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
Of course, Appium drivers and plugins are free to define additional insecure features of their own.
|
|
20
|
+
The following features are defined by official plugins:
|
|
21
|
+
|
|
22
|
+
| Feature Name | Plugin | Description |
|
|
23
|
+
|-----------------------|----------------|----------------------------------------------------------|
|
|
24
|
+
|`execute_driver_script`|`execute_driver`|Allows sending a request that has multiple Appium commands|
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- toc
|
|
4
|
+
|
|
5
|
+
title: appium server
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Launches an Appium server.
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
appium server
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
You can also omit the `server` subcommand:
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
appium
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Options
|
|
21
|
+
|
|
22
|
+
!!! note
|
|
23
|
+
|
|
24
|
+
All of these options can also be set via a [Configuration File](../../guides/config.md). Options
|
|
25
|
+
set on the command line will override any options found in a configuration file.
|
|
26
|
+
|
|
27
|
+
|<div style="width:15em">Argument</div>|Description|Type|<div style="width:7em">Default</div>|
|
|
28
|
+
|--|--|--|--|
|
|
29
|
+
|`--address`, `-a`|IPv4/IPv6 address to listen on|string|`0.0.0.0`|
|
|
30
|
+
|`--allow-cors`|Allow web browser connections from any host|boolean|`false`|
|
|
31
|
+
|`--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>|`[]`|
|
|
32
|
+
|`--base-path`, `-pa`|Base path to use as the prefix for all webdriver routes running on the server|string|`""`|
|
|
33
|
+
|`--callback-address`, `-ca`|Callback IP address|string|`0.0.0.0`|
|
|
34
|
+
|`--callback-port`, `-cp`|Callback port|integer|`4723`|
|
|
35
|
+
|`--config`|Path to an [Appium configuration JSON file](../../guides/config.md)|string||
|
|
36
|
+
|`--debug-log-spacing`|Add exaggerated spacing in logs to help with visual inspection|boolean|`false`|
|
|
37
|
+
|`--default-capabilities`, `-dc`|Capabilities that will be used for each session, unless overridden by received capabilities|object||
|
|
38
|
+
|`--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>|`[]`|
|
|
39
|
+
|`--driver`|Driver-specific configuration. Keys should correspond to driver package names|object||
|
|
40
|
+
|`--drivers-import-chunk-size`|Maximum number of drivers that can be imported in parallel on server startup|number|`3`|
|
|
41
|
+
|`--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`|
|
|
42
|
+
|`--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`|
|
|
43
|
+
|`--local-timezone`|Use local timezone for log timestamps|boolean|`false`|
|
|
44
|
+
|`--log`, `-g`|Path to a file where the server logs should be output. This does not affect output on the console.|string||
|
|
45
|
+
|`--log-filters`|List of log filtering rules. See the [log filtering guide](../../guides/log-filters.md) for details.|array||
|
|
46
|
+
|`--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`|
|
|
47
|
+
|`--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`|
|
|
48
|
+
|`--log-no-colors`|Disable colors in the server log|boolean|`false`|
|
|
49
|
+
|`--log-timestamp`|Show timestamps in the server log|boolean|`false`|
|
|
50
|
+
|`--long-stacktrace`|Add long stack traces to log entries. Recommended for debugging only.|boolean|`false`|
|
|
51
|
+
|`--max-ipc-data-size`|Maximum byte size of IPC message objects.|integer|`1048576` (1MB)|
|
|
52
|
+
|`--max-ipc-topics`|Maximum number of IPC topics per session.|integer|`1000`|
|
|
53
|
+
|`--no-perms-check`|Skip various permission checks on the server startup|boolean|`false`|
|
|
54
|
+
|`--nodeconfig`|JSON configuration for registering Appium as a node with Selenium Grid 3|object||
|
|
55
|
+
|`--plugin`|Plugin-specific configuration. Keys should correspond to plugin package names|object||
|
|
56
|
+
|`--plugins-import-chunk-size`|Maximum number of plugins that can be imported in parallel on server startup|number|`7`|
|
|
57
|
+
|`--port`, `-p`|Port to listen on|integer|`4723`|
|
|
58
|
+
|`--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`|
|
|
59
|
+
|`--session-override`|Enable session override (clobbering)|boolean|`false`|
|
|
60
|
+
|`--shutdown-timeout`|Timeout (in milliseconds) for waiting on all active connections to close, when shutting down the server|number|`5000`|
|
|
61
|
+
|`--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||
|
|
62
|
+
|`--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||
|
|
63
|
+
|`--strict-caps`|Prevent creation of new client sessions that use unsupported capabilities|boolean|`false`|
|
|
64
|
+
|`--tmp`|Absolute path to the directory used for temporary files|string|[`os.tmpdir()`](https://nodejs.org/api/os.html#ostmpdir)|
|
|
65
|
+
|`--use-drivers`|List of drivers to activate. By default, all installed drivers are activated.|array<string>|`[]`|
|
|
66
|
+
|`--use-plugins`|List of plugins to activate. By default, no plugins are activated. Set to `["all"]` to activate all installed plugins.|array<string>|`[]`|
|
|
67
|
+
|`--webhook`, `-G`|URL for an HTTP listener where the server logs should be output. This does not affect output on the console.|string||
|
|
68
|
+
|
|
69
|
+
### Info Options
|
|
70
|
+
|
|
71
|
+
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.
|
|
72
|
+
|
|
73
|
+
|<div style="width:10em">Argument</div>|Description|
|
|
74
|
+
|--|--|
|
|
75
|
+
|`--show-build-info`|Print detailed information on the Appium server version|
|
|
76
|
+
|`--show-config`|Print the current Appium server configuration details|
|
|
77
|
+
|`--show-debug-info`|Print information on the current environment: details about the operating system, Node.js, and Appium itself|
|
|
78
|
+
|`--version`, `-v`|Print the Appium server version|
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: appium setup
|
|
3
|
+
---
|
|
4
|
+
<style>
|
|
5
|
+
ul[data-md-component="toc"] .md-nav {
|
|
6
|
+
display: none;
|
|
7
|
+
}
|
|
8
|
+
</style>
|
|
9
|
+
|
|
10
|
+
Installs a specific preset of extensions (drivers and plugins), or uninstalls all extensions.
|
|
11
|
+
When installing a preset, any already installed extensions are kept intact.
|
|
12
|
+
|
|
13
|
+
The following sub-subcommands are supported: `browser`, `desktop`, `mobile`, and `reset`.
|
|
14
|
+
|
|
15
|
+
Refer to the [Ecosystem documentation](../../ecosystem/index.md) to learn more about the extensions
|
|
16
|
+
mentioned below.
|
|
17
|
+
|
|
18
|
+
## `browser`
|
|
19
|
+
|
|
20
|
+
Installs the following extensions for browser webview testing:
|
|
21
|
+
|
|
22
|
+
* Drivers: `safari`[^1], `gecko`, `chromium`
|
|
23
|
+
* Plugins: `images`, `inspector`
|
|
24
|
+
|
|
25
|
+
#### Usage
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
appium setup browser
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## `desktop`
|
|
32
|
+
|
|
33
|
+
Installs the following extensions for desktop application testing:
|
|
34
|
+
|
|
35
|
+
* Drivers: `mac2`[^1], `windows`[^2]
|
|
36
|
+
* Plugins: `images`, `inspector`
|
|
37
|
+
|
|
38
|
+
#### Usage
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
appium setup desktop
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## `mobile`
|
|
45
|
+
|
|
46
|
+
Installs the following extensions for mobile testing:
|
|
47
|
+
|
|
48
|
+
* Drivers: `uiautomator2`, `xcuitest`[^1], `espresso`
|
|
49
|
+
* Plugins: `images`, `inspector`
|
|
50
|
+
|
|
51
|
+
#### Usage
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
appium setup mobile
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
You can also omit the `mobile` sub-subcommand:
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
appium setup
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## `reset`
|
|
64
|
+
|
|
65
|
+
Uninstalls all installed extensions, along with their manifest files, from the Appium home
|
|
66
|
+
directory. This can be useful if you experience configuration issues on server startup, for
|
|
67
|
+
example, due to a failed upgrade attempt from an older Appium version.
|
|
68
|
+
|
|
69
|
+
#### Usage
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
appium setup reset
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
[^1]: Only installed if the host machine is running macOS.
|
|
76
|
+
[^2]: Only installed if the host machine is running Windows.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- toc
|
|
4
|
+
|
|
5
|
+
title: Reference
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
This section of the Appium documentation provides a reference to the core interfaces supported within the
|
|
9
|
+
Appium server:
|
|
10
|
+
|
|
11
|
+
<div class="grid cards" markdown>
|
|
12
|
+
|
|
13
|
+
- :octicons-command-palette-16: [__Command Line Interface__](./cli/index.md)
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
Learn how to use the Appium command-line executable
|
|
18
|
+
|
|
19
|
+
- :material-lan-connect: [__Session Properties__](./session/index.md)
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
See the values of global Appium session properties
|
|
24
|
+
|
|
25
|
+
- :material-cloud-braces: [__API Endpoints__](./api/index.md)
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
View endpoints supported by the core Appium server
|
|
30
|
+
|
|
31
|
+
</div>
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- toc
|
|
4
|
+
|
|
5
|
+
title: Capabilities
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
The following [capabilities](../../guides/caps.md) are recognized by the Appium server/base driver,
|
|
9
|
+
and are therefore supported by all drivers as well. Some capabilities are directly handled by the
|
|
10
|
+
server/base driver, while others are only validated before being passed to the actual driver.
|
|
11
|
+
|
|
12
|
+
!!! note
|
|
13
|
+
|
|
14
|
+
Capabilities not listed here will _not_ be rejected by Appium: they will simply be forwarded
|
|
15
|
+
directly to the active driver/plugin.
|
|
16
|
+
|
|
17
|
+
### Required Capabilities
|
|
18
|
+
|
|
19
|
+
These capabilities are used in the Appium server/base driver, and are explicitly required in all
|
|
20
|
+
Appium sessions.
|
|
21
|
+
|
|
22
|
+
| Capability | Description | Type |
|
|
23
|
+
|-------------------------|---------------------------------------------|-----------|
|
|
24
|
+
| `platformName` | Type of platform hosting the app or browser | `string` |
|
|
25
|
+
| `appium:automationName` | Name of the Appium driver to use | `string` |
|
|
26
|
+
|
|
27
|
+
### Optional Capabilities
|
|
28
|
+
|
|
29
|
+
These capabilities are used in the Appium server/base driver, but are optional, and may have a
|
|
30
|
+
default value.
|
|
31
|
+
|
|
32
|
+
| <div style="width:19em">Capability</div> | Description | Type | Default |
|
|
33
|
+
|--|--|--|--|
|
|
34
|
+
| `webSocketUrl` | Toggle support of the WebDriver BiDi protocol | `boolean` ||
|
|
35
|
+
| `appium:eventTimings` (deprecated) | Toggle collection of [Event Timings](../../guides/event-timing.md). This capability is deprecated - please use the [`getLogEvents`](../api/appium.md#getlogevents) endpoint instead. | `boolean` ||
|
|
36
|
+
| `appium:newCommandTimeout` | Number of seconds the Appium server should wait for clients to send commands before stopping the session. A value of `0` disables the timeout. | `number` | `60` |
|
|
37
|
+
| `appium:printPageSourceOnFindFailure` | Toggle retrieval of the the page source and its printing to the Appium log, whenever a request to find an element fails | `boolean` ||
|
|
38
|
+
|
|
39
|
+
### Validated Capabilities
|
|
40
|
+
|
|
41
|
+
These capabilities are not directly used in the Appium server/base driver, but are still subject to
|
|
42
|
+
validation checks due to their relevance in other drivers. The actual handling of these
|
|
43
|
+
capabilities is optional and entirely driver-dependent.
|
|
44
|
+
|
|
45
|
+
| Capability | Validation |
|
|
46
|
+
|-----------------------------------|---------------------------------------------------------------|
|
|
47
|
+
| `platformVersion` | Must be `string` |
|
|
48
|
+
| `appium:app` | Must be `string`; empty values are ignored |
|
|
49
|
+
| `appium:autoLaunch` (deprecated) | Must be `boolean` |
|
|
50
|
+
| `appium:autoWebview` | Must be `boolean` |
|
|
51
|
+
| `appium:fullReset` | Must be `boolean`; mutually exclusive with `appium:noReset` |
|
|
52
|
+
| `appium:language` | Must be `string` |
|
|
53
|
+
| `appium:locale` | Must be `string` |
|
|
54
|
+
| `appium:orientation` | Must be either `LANDSCAPE` or `PORTRAIT` |
|
|
55
|
+
| `appium:noReset` | Must be `boolean`; mutually exclusive with `appium:fullReset` |
|
|
56
|
+
| `appium:udid` | Must be `string` |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- toc
|
|
4
|
+
|
|
5
|
+
title: Session Properties
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
An Appium session has several key properties, each with its own set of supported values:
|
|
9
|
+
capabilities, execute methods, settings, locator strategies, and others. The supported values for
|
|
10
|
+
each property are primarily defined by the active driver and plugins, but some properties also have
|
|
11
|
+
common values provided by the Appium server and its base driver:
|
|
12
|
+
|
|
13
|
+
<div class="grid cards" markdown>
|
|
14
|
+
|
|
15
|
+
- [__Capabilities__](./caps.md)
|
|
16
|
+
|
|
17
|
+
A small set of basic capabilities
|
|
18
|
+
|
|
19
|
+
- [__Command Endpoints__](../api/index.md)
|
|
20
|
+
|
|
21
|
+
The core set of API endpoints
|
|
22
|
+
|
|
23
|
+
</div>
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
hide:
|
|
3
|
+
- navigation
|
|
4
|
+
- toc
|
|
5
|
+
|
|
6
|
+
title: Additional Resources
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Here you can find links to additional Appium resources around the web:
|
|
10
|
+
|
|
11
|
+
## Websites
|
|
12
|
+
|
|
13
|
+
- [Appium Pro](https://appiumpro.com) - a blog and newsletter written by one of Appium's
|
|
14
|
+
maintainers, Jonathan Lipps, with lots of useful guides
|
|
15
|
+
|
|
16
|
+
## Online Courses
|
|
17
|
+
|
|
18
|
+
- [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
|
|
19
|
+
- [Mobile Test Automation with Appium](https://testautomationu.applitools.com/appium-java-tutorial/) - a video course by Moataz Nabil
|
|
20
|
+
- [Advanced Appium](https://www.linkedin.com/learning/advanced-appium) - a video course by Jonathan Lipps
|
|
21
|
+
|
|
22
|
+
## Conference Archives
|
|
23
|
+
|
|
24
|
+
- [AppiumConf 2018](https://www.youtube.com/playlist?list=PLhr2WKNPXcZOmOf1k2aqkbMZwnZb2pSZL)
|
|
25
|
+
- [AppiumConf 2019](https://www.youtube.com/playlist?list=PL9Z-JgiTsOYSfJh9YKI9Stj3FMwHERw6w)
|
|
26
|
+
- [AppiumConf 2021](https://www.youtube.com/playlist?list=PL9Z-JgiTsOYRCcJhDfmKAah9XmAp2b903)
|
|
27
|
+
- [AppiumConf 2024](https://www.youtube.com/playlist?list=PL9Z-JgiTsOYQaU5i5LJtAWlh5WVZPi3If)
|
|
28
|
+
- [SeleniumConf & AppiumConf 2025](https://www.youtube.com/playlist?list=PLRdSclUtJDYV2R92TLbmwxws6clruuTjH)
|