npmpackage.info

Gathering detailed insights and metrics for @appium/types

Other packages similar to @appium/types

@types/appium-adb

9.12.0

Stub TypeScript definitions entry for appium-adb, which provides its own types definitions

@appium/eslint-config-appium-ts

1.0.4

Shared ESLint config for Appium projects (TypeScript version)

Gathering detailed insights and metrics for @appium/types

@appium/types - 0.25.3 | npmpackage.info

@appium/types

Cross-platform automation framework for all kinds of apps, built on top of the W3C WebDriver protocol

0.25.3

19,774

Apache-2.0

JavaScript

422.00 B

37,340,649 5

Installations

npm install @appium/types

Developer 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.2/node@v22.11.0+arm64 (darwin)

Score

Supply Chain

75.7

Quality

93.1

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

12

Total

6,505

Closed

743

Merged

5,750

Issues

Open

112

Total

13,854

Closed

13,742

Releases

1,361

appium@2.18.0

Updated on Apr 25, 2025

@appium/execute-driver-plugin@4.0.5

Updated on Apr 25, 2025

@appium/logger@1.7.0

Updated on Apr 25, 2025

@appium/docutils@1.1.0

Updated on Apr 25, 2025

@appium/base-driver@9.17.0

Updated on Apr 25, 2025

@appium/support@6.1.0

Updated on Apr 25, 2025

View All 1,361 releases

Languages

JavaScript

TypeScript

HTML

Shell

Python

CSS

Ruby

JavaScript (78.54%)

TypeScript (20.31%)

HTML (0.95%)

Shell (0.09%)

Python (0.04%)

CSS (0.03%)

Ruby (0.03%)

Developer

appium

Download Statistics

Total Downloads

37,340,649

Last Day

135,096

Last Week

652,713

Last Month

2,751,528

Last Year

25,645,820

GitHub Statistics

Apache-2.0 License

19,774 Stars

11,478 Commits

6,168 Forks

879 Watchers

150 Branches

355 Contributors

Updated on May 09, 2025

Bundle Size

769.00 B

Minified

422.00 B

Minified + Gzipped

Bundlephobia

Maintainers

View All 355 Contributors

Package Meta Information

Latest Version

0.25.3

Package Id

@appium/types@0.25.3

Unpacked Size

298.91 kB

Size

62.29 kB

File Count

NPM Version

lerna/8.2.2/node@v22.11.0+arm64 (darwin)

Node Version

22.11.0

Published on

Apr 25, 2025

Total Downloads

Cumulative downloads

Total Downloads

37,340,649

Last Day

53.7%

135,096

Compared to previous day

Last Week

5.5%

652,713

Compared to previous week

Last Month

-5.5%

2,751,528

Compared to previous month

Last Year

154.6%

25,645,820

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@appium/logger @appium/schema @appium/tsconfig type-fest

Cross-platform test automation for native, hybrid, mobile web and desktop apps.

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 xcuitest and uiautomator2 have 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?.

License

Apache-2.0

@appium/logger package is under ISC License.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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: 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: 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/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

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5

/10

Last Scanned on 2025-05-05

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

Other packages similar to @appium/types

Other packages similar to @appium/types

@appium/types

Installations

Developer Guide

Yes

N/A

^14.17.0 || ^16.13.0 || >=18.0.0

22.11.0

lerna/8.2.2/node@v22.11.0+arm64 (darwin)

Score

Pull Requests

12

6,505

743

5,750

Issues

112

13,854

13,742

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

769.00 B

422.00 B

Maintainers

Package Meta Information

Total Downloads

37,340,649

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Migrating From Appium 1 to Appium 2

Installation

Drivers

Clients

Plugins

Server Command Line Interface

Why Appium?

Sponsors

Development and Strategic Partners

Other Sponsors

License

10

10

10

10

9

4

2

1

0

0

0

0

5

/10