Gathering detailed insights and metrics for appium
Gathering detailed insights and metrics for appium
Cross-platform automation framework for all kinds of apps, built on top of the W3C WebDriver protocol
Installations
npm install appiumDeveloper Guide
BETA
Typescript
Yes
Module System
N/A
Min. Node Version
^14.17.0 || ^16.13.0 || >=18.0.0
Node Version
22.11.0
NPM Version
lerna/8.2.1/node@v22.11.0+arm64 (darwin)
Score
71.2
Supply Chain
88.7
Quality
94.8
Maintenance
50
Vulnerability
90.4
License
Releases
1,344
@appium/driver-test-support@0.7.8
@appium/driver-test-support@0.7.8
Updated on Mar 17, 2025
@appium/base-driver@9.16.4
@appium/base-driver@9.16.4
Updated on Mar 17, 2025
@appium/storage-plugin@0.1.1
@appium/storage-plugin@0.1.1
Updated on Mar 17, 2025
@appium/fake-plugin@3.2.5
@appium/fake-plugin@3.2.5
Updated on Mar 17, 2025
@appium/test-support@3.1.8
@appium/test-support@3.1.8
Updated on Mar 17, 2025
appium@2.17.1
appium@2.17.1
Updated on Mar 17, 2025
Contributors
354
Unable to fetch Contributors
Languages
7
JavaScript
TypeScript
HTML
Shell
Python
CSS
Ruby
JavaScript (78.75%)
TypeScript (20.1%)
HTML (0.96%)
Shell (0.09%)
Python (0.05%)
CSS (0.03%)
Ruby (0.03%)
Developer
Download Statistics
Total Downloads
42,501,291
Last Day
75,325
Last Week
421,610
Last Month
1,677,545
Last Year
13,624,530
GitHub Statistics
Apache-2.0 License
19,568 Stars
11,419 Commits
6,136 Forks
881 Watchers
146 Branches
354 Contributors
Updated on Mar 21, 2025
Maintainers
8
Package Meta Information
Latest Version
2.17.1
Package Id
appium@2.17.1
Unpacked Size
1.11 MB
Size
237.95 kB
File Count
208
NPM Version
lerna/8.2.1/node@v22.11.0+arm64 (darwin)
Node Version
22.11.0
Published on
Mar 17, 2025
Total Downloads
Cumulative downloads
Total Downloads
42,501,291
Last Day
10.2%
75,325
Compared to previous day
Last Week
10.2%
421,610
Compared to previous week
Last Month
16.2%
1,677,545
Compared to previous month
Last Year
74.9%
13,624,530
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
29
@appium/base-driver@appium/base-plugin@appium/docutils@appium/logger@appium/schema@appium/support@appium/types@sidvind/better-ajv-errorsajvajv-formatsargparseasync-lockasyncboxaxiosbluebirdlilconfiglodashlru-cacheorapackage-changedresolve-fromsemversource-map-supportteen_processtype-festwinstonwrap-ansiwsyaml
Cross-platform test automation for native, hybrid, mobile web and desktop apps.
Documentation | Get Started | Ecosystem | Changelog | Contributing Guide | Discussion Forum
Appium is an open-source automation framework that provides WebDriver-based automation possibilities for a wide range of different mobile, desktop and IoT platforms. Appium is modular and extensible, and supports multiple programming languages, which means there is an entire ecosystem of related software:
- Drivers add support for automating specific platforms
- Clients allow writing Appium tests in your programming language of choice
- Plugins allow to further extend Appium functionality
Migrating From Appium 1 to Appium 2
As of January 1st, 2022, the Appium team no longer maintains or supports Appium 1. All officially supported platform drivers are only compatible with Appium 2.
Please read the Migration Guide if you are still using Appium 1.
[!WARNING] If you use Appium Desktop or Appium Server GUI, you will not be able to upgrade to Appium 2, as both of these tools have been deprecated. Please use Appium Inspector in combination with a standalone Appium 2 server.
Installation
Appium can be installed using npm (other package managers are not currently supported). Please
check the installation docs for the
system requirements and further information.
If upgrading from Appium 1, make sure Appium 1 is fully uninstalled (npm uninstall -g appium).
Unexpected errors might appear if this has not been done.
1npm i -g appium
Note that this will only install the core Appium server, which cannot automate anything on its own. Please install drivers for your target platforms in order to automate them.
Drivers
Appium supports app automation across a variety of platforms, like iOS, Android, macOS, Windows, and more. Each platform is supported by one or more "drivers", which know how to automate that particular platform. You can find a full list of officially-supported and third-party drivers in Appium Ecosystem's Drivers page.
Driver management is done using Appium's Extension command-line interface:
1# Install an official driver from npm (see documentation for a list of such drivers) 2appium driver install <driver-name> 3# Install any driver from npm 4appium driver install --source=npm <driver-name> 5# See documentation for installation from other sources 6 7# List already installed drivers 8appium driver list --installed 9# Update a driver (it must be already installed) 10# This will NOT update the major version, in order to prevent breaking changes 11appium driver update <driver-name> 12# Update a driver to the most recent version (may include breaking changes) 13appium driver update <driver-name> --unsafe 14# Uninstall a driver (it won't last forever, will it?) 15appium driver uninstall <driver-name>
Clients
Client libraries enable writing Appium tests in different programming languages. There are officially-supported clients for Java, Python, Ruby, and .NET C#, as well as third-party clients for other languages. You can find a full list of clients in Appium Ecosystem's Clients page.
Plugins
Plugins allow you to extend server functionality without changing the server code. The main difference between drivers and plugins is that the latter must be explicitly enabled on Appium server startup (all installed drivers are enabled by default):
1appium --use-plugins=<plugin-name>
You can find a full list of officially-supported and third-party plugins in Appium Ecosystem's Plugins page.
Similarly to drivers, plugin management is also done using Appium's Extension command-line interface:
1# Install an official plugin from npm (see documentation for a list of such plugins) 2appium plugin install <plugin-name> 3# Install any plugin from npm 4appium plugin install --source=npm <plugin-name> 5# See documentation for installation from other sources 6 7# List already installed plugins 8appium plugin list --installed 9# Update a plugin (it must be already installed) 10# This will NOT update the major version, in order to prevent breaking changes 11appium plugin update <plugin-name> 12# Update a plugin to the most recent version (may include breaking changes) 13appium plugin update <plugin-name> --unsafe 14# Uninstall a plugin 15appium plugin uninstall <plugin-name>
Server Command Line Interface
In order to start sending commands to the Appium server, it must be running on the URL and port where your client library expects it to listen. Appium's command-line interface is used to launch and configure the server:
1# Start the server on the default host (0.0.0.0) and port (4723) 2appium server 3# You can also omit the 'server' subcommand 4appium 5# Start the server on the given host, port and use a custom base path prefix (the default prefix is '/') 6appium --address 127.0.0.1 --port 9000 --base-path /wd/hub
Appium supports execution of parallel server processes, as well as parallel driver sessions within a single server process. Refer the corresponding driver documentations regarding which mode is optimal for the particular driver or whether it supports parallel sessions.
Why Appium?
- You usually don't have to recompile your app or modify it in any way, due to the use of standard automation APIs on all platforms.
- You can write tests with your favorite dev tools using any WebDriver-compatible language such as Java, Python, Ruby and C#. There are also third party client implementations for other languages.
- You can use any testing framework.
- Some drivers like
xcuitestanduiautomator2have built-in mobile web and hybrid app support. Within the same script, you can switch seamlessly between native app automation and webview automation, all using the WebDriver model that's already the standard for web automation. - You can run your automated tests locally and in a cloud. There are multiple cloud providers that support various Appium drivers (mostly targeting iOS and Android mobile automation).
- Appium Inspector can be used to visually inspect the page source of applications across different platforms, facilitating easier test development.
Investing in the WebDriver protocol means you are betting on a single, free, and open protocol for testing that has become a web standard. Don't lock yourself into a proprietary stack.
For example, if you use Apple's XCUITest library without Appium, you can only write tests using Obj-C/Swift, and you can only run tests through Xcode. Similarly, with Google's UiAutomator or Espresso, you can only write tests in Java/Kotlin. Appium opens up the possibility of true cross-platform native app automation, for mobile and beyond!
If you are looking for a more comprehensive description of what this is all about, please read our documentation on How Does Appium Work?.
Sponsors
Appium has a Sponsorship Program! If you or your company uses Appium and wants to give back financially to the project, we use these funds to encourage development and contributions, as well as support other open source projects we rely on. Become a sponsor via our OpenCollective page.
Development and Strategic Partners
Appium is incredibly grateful to our Development and Strategic Partners for their sustained contribution of project development and leadership!
Other Sponsors
A full list of sponsors is available at our Sponsors page.
License
@appium/logger package is under ISC License.
No vulnerabilities found.
Reason
30 commit(s) and 19 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/appium/.github/SECURITY.md:1
- Info: Found linked content: github.com/appium/.github/SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: github.com/appium/.github/SECURITY.md:1
Reason
Found 11/25 approved changesets -- score normalized to 4
Reason
badge detected: InProgress
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-labeler.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/auto-labeler.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:98: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:100: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/clean-cache.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/clean-cache.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-sync-docs-translations.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-sync-docs-translations.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-sync-docs-translations.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-sync-docs-translations.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/crowdin-sync-docs-translations.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-sync-docs-translations.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-update-docs-resources.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-update-docs-resources.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/crowdin-update-docs-resources.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/crowdin-update-docs-resources.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/deploy.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/deploy.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/docs.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/docs.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fossa.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/fossa.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/fossa.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/fossa.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/on-hold.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/on-hold.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-title.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/pr-title.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-doc.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/publish-doc.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-doc.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/publish-doc.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-doc.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/publish-doc.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/renovate.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/renovate.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/renovate.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/appium/appium/renovate.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/deploy.yml:38
- Warn: npmCommand not pinned by hash: .github/workflows/deploy.yml:40
- Warn: pipCommand not pinned by hash: .github/workflows/docs.yml:48
- Warn: downloadThenRun not pinned by hash: .github/workflows/fossa.yml:23
- Warn: pipCommand not pinned by hash: .github/workflows/publish-doc.yml:35
- Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 12 third-party GitHubAction dependencies pinned
- Info: 2 out of 4 npmCommand dependencies pinned
- Info: 0 out of 2 pipCommand dependencies pinned
- Info: 0 out of 1 downloadThenRun dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: topLevel permissions set to 'read-all': .github/workflows/auto-labeler.yml:7
- Info: topLevel 'contents' permission set to 'read': .github/workflows/build.yml:49
- Warn: no topLevel permission defined: .github/workflows/clean-cache.yml:1
- Warn: no topLevel permission defined: .github/workflows/crowdin-sync-docs-translations.yml:1
- Warn: no topLevel permission defined: .github/workflows/crowdin-update-docs-resources.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/deploy.yml:9
- Warn: no topLevel permission defined: .github/workflows/docs.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/fossa.yml:7
- Warn: no topLevel permission defined: .github/workflows/on-hold.yml:1
- Warn: no topLevel permission defined: .github/workflows/pr-title.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish-doc.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/renovate.yml:19
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 29 are checked with a SAST tool
Reason
12 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-c76h-2ccp-4975
- Warn: Project is vulnerable to: GHSA-rv73-9c8w-jp4c
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
5
/10
Last Scanned on 2025-03-17
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More