# @appium/schema

> Appium Configuration Schema

Latest version **1.3.0** (published 2026-07-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @appium/schema
pnpm add @appium/schema
yarn add @appium/schema
bun add @appium/schema
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score; popular repo.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2026-07-25 |
| First published | 2022-04-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^20.19.0 \|\| ^22.12.0 \|\| >=24.0.0 |
| Dependencies | 1 |
| Unpacked size | 94.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 21954 |
| Author | https://github.com/appium |
| Maintainers | jlipps, nick.mokhnach, kazucocoa |
| Keywords | android, automation, firefoxos, ios, javascript, selenium, testing, webdriver |

## Links

- npm: https://www.npmjs.com/package/@appium/schema
- Repository: https://github.com/appium/appium
- Homepage: https://appium.io
- Issues: https://github.com/appium/appium/issues
- npm.io page: https://npm.io/package/@appium/schema

## Dependencies (1)

- [json-schema](https://npm.io/package/json-schema.md) 0.4.0

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2026-07-25
- 1.0.0-rc.1 (rc) — 2025-08-14
- 1.2.1 — 2026-06-18
- 1.2.0 — 2026-05-31
- 1.1.1 — 2026-05-06
- 1.1.0 — 2026-03-08
- 1.0.1 — 2026-01-26
- 1.0.0 — 2025-08-18
- 0.8.1 — 2025-02-20
- 0.8.0 — 2025-02-19
- 0.7.1 — 2025-01-02
- 0.7.0 — 2024-10-15
- 0.6.1 — 2024-06-11
- 0.5.0 — 2023-12-18
- 0.4.2 — 2023-11-14
- … 20 more at https://npm.io/package/@appium/schema/versions

## README

# @appium/schema

> JSON schema for [Appium](https://github.com/appium/appium) configuration files

## Description

This package is used internally by Appium, but can also be used to validate Appium configuration files in other contexts.

## Install

```bash
npm i @appium/schema
```

## Usage

The schema is exported as a JS object:

```js
const { AppiumConfigJsonSchema } = require('@appium/schema');
```

It is also provided as a JSON file (since this is a JSON schema, after all):

```js
const schema = require('@appium/schema/lib/appium-config.schema.json');
```

## See Also

[@appium/types](https://npm.im/@appium/types) exports a TypeScript type `AppiumConfig` (generated from this package) for typesafe configuration objects; this may be useful if your Appium configuration is written in JS (e.g., `.appiumrc.js`). Example:

```js
// @ts-check
/** @type {import('@appium/types').AppiumConfig} */
module.exports = {
  server: {
    port: 1234,
    host: '127.0.0.1'
  }
}
```

## Notes

`lib/appium-config.schema.json` is generated by this package from `lib/appium-config-schema.js` (the single source of truth), but is under version control to avoid chicken-or-egg build problems.

## License

Apache-2.0

---
_Source: https://npm.io/package/@appium/schema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._