mirror of
https://github.com/appium/appium.git
synced 2025-12-30 14:49:57 -06:00
docs(appium): Update documentation translations (#21534)
Co-authored-by: mykola-mokhnach <7767781+mykola-mokhnach@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
b6e51c6417
commit
d280e2af0f
@@ -1,28 +0,0 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Command Reference
|
||||
---
|
||||
|
||||
Here you can find various commands exposed by the main Appium module through its base driver, as
|
||||
well as the commands available in several plugins.
|
||||
|
||||
!!! note
|
||||
|
||||
```
|
||||
The Appium base driver only exposes a few commands, as it is not meant to be used on its own.
|
||||
Please refer to the documentation of your [Appium driver](../ecosystem/drivers.md) to learn
|
||||
about the commands it exposes, and then check your [Appium client](../ecosystem/clients.md)
|
||||
documentation for the exact syntax of that command.
|
||||
```
|
||||
|
||||
The command listings can be found here:
|
||||
|
||||
- [Base Driver](./base-driver.md)
|
||||
- [Execute Driver Plugin](./execute-driver-plugin.md)
|
||||
- [Images Plugin](./images-plugin.md)
|
||||
- [Inspector](https://github.com/appium/appium-inspector/tree/main/plugins)
|
||||
- [Relaxed Caps Plugin](./relaxed-caps-plugin.md)
|
||||
- [Storage Plugin](./storage-plugin.md)
|
||||
- [Universal XML Plugin](./universal-xml-plugin.md)
|
||||
@@ -29,7 +29,7 @@ Appium driver or plugin developers can choose to include these tools in their dr
|
||||
|
||||
The Appium Doctor tool can be used to validate whether all prerequisites and other environment
|
||||
details needed for the driver/plugin have been set up correctly. The tool can be accessed via the
|
||||
[`doctor` command in the Appium CLI](../cli/extensions.md#doctor):
|
||||
[`doctor` command in the Appium CLI](../reference/cli/extensions.md#doctor):
|
||||
|
||||
```sh
|
||||
appium {driver|plugin} doctor <extension-name>
|
||||
|
||||
@@ -28,16 +28,16 @@ In order to validate whether an app bundle downloaded from the given URL could b
|
||||
steps are applied:
|
||||
|
||||
1. The script checks if the given URL is already present in the cache.
|
||||
If yes then it tries to fetch previously remembered
|
||||
[Last-Modified](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified)
|
||||
or [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header values for it.
|
||||
If yes then it tries to fetch previously remembered
|
||||
[Last-Modified](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified)
|
||||
or [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header values for it.
|
||||
2. If `ETag` value is present then it is put into
|
||||
[If-None-Match request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match).
|
||||
Else if `Last-Modified` header value is present then it is put into
|
||||
[If-Modified-Since request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since).
|
||||
Otherwise, no caching is applied.
|
||||
[If-None-Match request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match).
|
||||
Else if `Last-Modified` header value is present then it is put into
|
||||
[If-Modified-Since request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since).
|
||||
Otherwise, no caching is applied.
|
||||
3. If the response status is equal to `304` then the previously cached binary is used,
|
||||
otherwise the cached entry is reset and refreshed.
|
||||
otherwise the cached entry is reset and refreshed.
|
||||
|
||||
## Caching of Local Application Bundles
|
||||
|
||||
@@ -45,9 +45,9 @@ It only makes sense to cache application bundles if they need some preprocessing
|
||||
For example, on iOS `.ipa` bundles must be unzipped, because the system installer only works with `.app` folders.
|
||||
|
||||
1. The script verifies if the given bundle path is already present in the cache. If the bundle was not in the cache yet
|
||||
then it gets preprocessed and added there.
|
||||
then it gets preprocessed and added there.
|
||||
2. The script validates the hashsum of the bundle and compares it to the previously stored one. If hash sums don't match
|
||||
then the cached item gets deleted and the preprocessing of the bundle repeats.
|
||||
then the cached item gets deleted and the preprocessing of the bundle repeats.
|
||||
|
||||
## How The Cache File System Is Configured
|
||||
|
||||
@@ -56,15 +56,15 @@ on per-process basis, so each test session initialized in scope of the same Appi
|
||||
of it. It is a [LRU Cache](https://www.npmjs.com/package/lru-cache) with the following limitations:
|
||||
|
||||
- Max items: 1024. You may customize it by providing a new value to
|
||||
the [APPIUM_APPS_CACHE_MAX_ITEMS](../cli/env-vars.md) environment variable.
|
||||
the [APPIUM_APPS_CACHE_MAX_ITEMS](../reference/cli/env-vars.md) environment variable.
|
||||
Do not set it to a lower number than the amount of apps in all parallel sessions per process.
|
||||
- Max time to live (TTL) for each entry: 24 hours.
|
||||
You may customize it by providing a new value to the
|
||||
[APPIUM_APPS_CACHE_MAX_AGE](../cli/env-vars.md) environment variable.
|
||||
[APPIUM_APPS_CACHE_MAX_AGE](../reference/cli/env-vars.md) environment variable.
|
||||
Do not set it to a lower number than the duration of a single session startup.
|
||||
- TTL is refreshed for each entry upon access
|
||||
- By default the full application URL is used as cache key. You may change this behavior
|
||||
by enabling the [APPIUM_APPS_CACHE_IGNORE_URL_QUERY](../cli/env-vars.md) environment variable.
|
||||
by enabling the [APPIUM_APPS_CACHE_IGNORE_URL_QUERY](../reference/cli/env-vars.md) environment variable.
|
||||
If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys.
|
||||
See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713)
|
||||
for more details.
|
||||
|
||||
@@ -70,6 +70,6 @@ In the past, events were available as a part of `GET /session/:id` response
|
||||
## Add a custom event
|
||||
|
||||
You can add custom events that will show up in the event timings data. You can send a custom event
|
||||
name to the Appium server using the [Log Custom Event API](../commands/base-driver.md#logcustomevent),
|
||||
and the server will store the timestamp. The [Get Log Events](../commands/base-driver.md#getlogevents)
|
||||
name to the Appium server using the [Log Custom Event API](../reference/api/base-driver.md#logcustomevent),
|
||||
and the server will store the timestamp. The [Get Log Events](../reference/api/base-driver.md#getlogevents)
|
||||
command can be used to retrieve named events' timestamps later on.
|
||||
|
||||
@@ -18,7 +18,7 @@ Other package managers are not currently supported.
|
||||
|
||||
## Using Appium's Extension CLI
|
||||
|
||||
With Appium's [Extension CLI](../cli/extensions.md), you let Appium manage drivers and plugins for
|
||||
With Appium's [Extension CLI](../reference/cli/extensions.md), you let Appium manage drivers and plugins for
|
||||
you. You will use CLI commands to tell Appium which extensions you would like to install, update,
|
||||
or remove. Here's an example of how you might install a driver using the CLI:
|
||||
|
||||
@@ -64,9 +64,9 @@ like any other dependency. Basically, whenever you run Appium, if you have not e
|
||||
|
||||
1. Try to determine whether the _current directory_ is inside an `npm` package.
|
||||
2. If so, it will check whether `appium` is a dependency (dev, prod, or peer) in the project's
|
||||
`package.json`
|
||||
`package.json`
|
||||
3. If so, _unless you have specified `APPIUM_HOME` in your environment_, Appium will ignore load
|
||||
drivers and plugins defined in that `package.json` file instead.
|
||||
drivers and plugins defined in that `package.json` file instead.
|
||||
|
||||
This means you are freely able to add Appium drivers and plugins as regular package dependencies or
|
||||
dev dependencies. For example, if your project has a `package.json` which includes the following:
|
||||
|
||||
@@ -34,13 +34,13 @@ When it comes to installing Appium 2 drivers, there are several approaches you c
|
||||
npm i -g appium --drivers=xcuitest,uiautomator2
|
||||
```
|
||||
|
||||
- Use the [Appium Extension CLI](../cli/extensions.md), for example:
|
||||
- Use the [Appium Extension CLI](../reference/cli/extensions.md), for example:
|
||||
|
||||
```bash
|
||||
appium driver install uiautomator2
|
||||
```
|
||||
|
||||
- Use the [Appium Setup CLI command](../cli/setup.md) (added in Appium `2.6`), for example:
|
||||
- Use the [Appium Setup CLI command](../reference/cli/setup.md) (added in Appium `2.6`), for example:
|
||||
|
||||
```bash
|
||||
appium setup mobile
|
||||
@@ -78,7 +78,7 @@ server and drivers are separate packages, they can release new versions independ
|
||||
other - this means that you no longer need to wait for a new Appium server release, but can install
|
||||
the latest driver versions right away.
|
||||
|
||||
Checking for driver updates is done by using the [Appium Extension CLI](../cli/extensions.md):
|
||||
Checking for driver updates is done by using the [Appium Extension CLI](../reference/cli/extensions.md):
|
||||
|
||||
```bash
|
||||
appium driver list --updates
|
||||
@@ -102,7 +102,7 @@ server package.
|
||||
!!! info "Actions Needed"
|
||||
|
||||
```
|
||||
Make sure to use the [Appium Extension CLI](../cli/extensions.md) to manage your drivers
|
||||
Make sure to use the [Appium Extension CLI](../reference/cli/extensions.md) to manage your drivers
|
||||
```
|
||||
|
||||
### Deprecated Packages No Longer Supported
|
||||
@@ -135,7 +135,7 @@ path to `/`, therefore the default server URL is now `http://localhost:4723/`.
|
||||
```
|
||||
In your test scripts, change the base path of the target server URL from `/wd/hub` to `/`.
|
||||
Alternatively, you can retain the Appium 1 base path by launching Appium with the
|
||||
`--base-path=/wd/hub` [command-line argument](../cli/args.md).
|
||||
`--base-path=/wd/hub` [command-line argument](../reference/cli/args.md).
|
||||
```
|
||||
|
||||
### Server Port 0 No Longer Supported
|
||||
@@ -173,8 +173,7 @@ appium --chromedriver-version=100 # Appium 1
|
||||
CHROMEDRIVER_VERSION=100 appium # Appium 2
|
||||
```
|
||||
|
||||
- Some options can now be passed as [capabilities](https://appium.io/docs/en/latest/guides/caps/),
|
||||
for example:
|
||||
- Some options can now be passed as [capabilities](./caps.md), for example:
|
||||
|
||||
```
|
||||
appium --chromedriver-executable=/path/to/chromedriver # Appium 1
|
||||
@@ -203,8 +202,8 @@ Appium 2 no longer attempts to parse the contents of filepaths passed to these o
|
||||
two ways to specify the value for these options:
|
||||
|
||||
- As strings, directly on the command line
|
||||
- `--nodeconfig` / `--default-capabilities`: JSON string
|
||||
- `--allow-insecure` / `--deny-insecure`: comma-separated list
|
||||
- `--nodeconfig` / `--default-capabilities`: JSON string
|
||||
- `--allow-insecure` / `--deny-insecure`: comma-separated list
|
||||
- In the [Appium Configuration file](./config.md)
|
||||
|
||||
!!! info "Actions Needed"
|
||||
@@ -339,14 +338,14 @@ support for these parameters. The following is a list of these changed endpoints
|
||||
parameters they no longer accept, as well as the parameters they continue to accept in Appium 2.
|
||||
|
||||
- `POST /session/:sessionId/appium/device/gsm_signal`
|
||||
- :octicons-x-24: `signalStrengh`
|
||||
- :octicons-check-24: `signalStrength`
|
||||
- :octicons-x-24: `signalStrengh`
|
||||
- :octicons-check-24: `signalStrength`
|
||||
- `POST /session/:sessionId/appium/element/:elementId/value`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
- `POST /session/:sessionId/appium/element/:elementId/replace_value`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
|
||||
!!! info "Actions Needed"
|
||||
|
||||
@@ -381,7 +380,7 @@ wish to take advantage of with Appium 2:
|
||||
|
||||
You are no longer limited to official drivers or plugins, or ones that the Appium team even knows
|
||||
about! Developers can now create their own custom drivers or plugins, which can be installed via
|
||||
Appium's [Extension CLI](../cli/extensions.md) from `npm`, `git`, GitHub, or even the local
|
||||
Appium's [Extension CLI](../reference/cli/extensions.md) from `npm`, `git`, GitHub, or even the local
|
||||
filesystem. Interested in building a driver or plugin? Check out the
|
||||
[Building Drivers](../developing/build-drivers.md) and
|
||||
[Building Plugins](../developing/build-plugins.md) guides.
|
||||
|
||||
@@ -22,7 +22,7 @@ this is the responsibility of the server admin who configures and launches the A
|
||||
|
||||
## Security Server Args
|
||||
|
||||
The [Server CLI Args](../cli/args.md) doc outlines three relevant arguments which may be passed to
|
||||
The [Server CLI Args](../reference/cli/args.md) doc outlines three relevant arguments which may be passed to
|
||||
Appium when starting it from the command line:
|
||||
|
||||
| <div style="width:10em">Parameter</div> | Description |
|
||||
|
||||
@@ -45,11 +45,11 @@ Appiumのドキュメントにようこそ！ Appiumはオープンソースプ
|
||||
- [**Introduction**](./intro/index.md) を読んで、主要なコンセプトを理解してください
|
||||
- [**Quickstart**](./quickstart/index.md) を通して、基本的なAndroidテストを用意、実行します。
|
||||
- 使用するドライバ、クライアント、プラグインの一覧については、 [**Ecosystem**](./ecosystem/index.md) ページを参照してください。
|
||||
- コマンドラインからAppiumを使用する場合、[**CLI リファレンス**](./cli/index.md)を参照してください。
|
||||
- Appiumとプラグインで公開されているコマンドの一覧は[**Command Reference**](./commands/index.md)を参照してください。
|
||||
- Consult the [**Reference**](./reference/index.md) page for information on the Appium CLI and supported endpoints
|
||||
- Read the different [**Guides**](./guides/migrating-2-to-3.md) for a variety of instructions, tips and tricks
|
||||
- Check out various third-party [**Resources**](./resources/index.md) to explore Appium around the web
|
||||
- 独自の Appium 拡張を作成するには、 [**Developer**](./developing/index.md) ドキュメントを参考にしてください。
|
||||
- For contributions to Appium itself, refer to the [**Contributing**](./contributing/index.md) page
|
||||
- Have a look at the [**Appium Blog**](./blog/index.md) to learn what's new in the project
|
||||
|
||||
</div>
|
||||
|
||||
@@ -180,9 +180,9 @@ will never have time to build. And so, with Appium 2, Appium has released a plug
|
||||
enables anyone to build and share modules that change how Appium works!
|
||||
|
||||
In the same way that drivers are easily shareable and consumable via the Appium driver CLI, plugins
|
||||
can be published and consumed via a parallel [Plugin CLI](../cli/extensions.md). Plugins can do all
|
||||
sorts of things, for example adding the ability for Appium to find and interact with screen regions
|
||||
based on a template image (as in the images). There are very few
|
||||
can be published and consumed via a parallel [Plugin CLI](../reference/cli/extensions.md). Plugins
|
||||
can do all sorts of things, for example adding the ability for Appium to find and interact with
|
||||
screen regions based on a template image (as in the images). There are very few
|
||||
limitations on what you can do with plugins, so you might also be interested in learning how to
|
||||
[Build Plugins](../developing/build-plugins.md) in Node.js that can be used with Appium.
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ npm install -g appium
|
||||
|
||||
## Appiumを実行する
|
||||
|
||||
Appiumは [コマンドラインを使用して](../cli/index.md)始めることができます：
|
||||
Appium can be started [using the command line](../reference/cli/index.md):
|
||||
|
||||
```
|
||||
appium
|
||||
|
||||
@@ -26,4 +26,4 @@ require the developer toolchain and SDKs for that platform to be installed.
|
||||
|
||||
In order to assist with driver requirements, each (official) driver comes with the Appium Doctor tool,
|
||||
which allows to verify if all requirements have been set up. Learn more about how to use this tool in
|
||||
the [Command-Line Usage documentation](../cli/extensions.md#doctor).
|
||||
the [Command-Line Usage documentation](../reference/cli/extensions.md#doctor).
|
||||
|
||||
@@ -24,34 +24,34 @@ According to the driver, in addition to a working Appium server, we also need to
|
||||
### Android SDK
|
||||
|
||||
- The easiest way to set up the Android SDK requirements is by downloading [Android Studio](https://developer.android.com/studio).
|
||||
We need to use its SDK manager (_Settings -> Languages & Frameworks -> Android SDK_)
|
||||
to download the following items:
|
||||
- Android SDK Platform (select whichever Android platform we want to automate, for example, API level 30)
|
||||
- Android SDK Platform-Tools
|
||||
We need to use its SDK manager (_Settings -> Languages & Frameworks -> Android SDK_)
|
||||
to download the following items:
|
||||
- Android SDK Platform (select whichever Android platform we want to automate, for example, API level 30)
|
||||
- Android SDK Platform-Tools
|
||||
- If you wish, you can also download these items without Android Studio:
|
||||
- Android SDK Platform can be downloaded using `sdkmanager` included in [Android command-line tools](https://developer.android.com/studio#command-line-tools-only)
|
||||
- [Android SDK Platform-Tools](https://developer.android.com/tools/releases/platform-tools)
|
||||
- Android SDK Platform can be downloaded using `sdkmanager` included in [Android command-line tools](https://developer.android.com/studio#command-line-tools-only)
|
||||
- [Android SDK Platform-Tools](https://developer.android.com/tools/releases/platform-tools)
|
||||
- Set up the `ANDROID_HOME` environment variable to point to the directory where the Android SDK is
|
||||
installed. You can usually find the path to this directory in the Android Studio SDK manager. It
|
||||
will contain the `platform-tools` and other directories.
|
||||
installed. You can usually find the path to this directory in the Android Studio SDK manager. It
|
||||
will contain the `platform-tools` and other directories.
|
||||
|
||||
### Java JDK
|
||||
|
||||
- Install the Java JDK (for the most recent Android API levels, JDK 9 is required, otherwise JDK
|
||||
8 is required). You can download this from [Oracle](https://jdk.java.net/) or [Adoptium](https://adoptium.net/en-GB/temurin/releases/).
|
||||
Make sure you get the JDK and not the JRE.
|
||||
8 is required). You can download this from [Oracle](https://jdk.java.net/) or [Adoptium](https://adoptium.net/en-GB/temurin/releases/).
|
||||
Make sure you get the JDK and not the JRE.
|
||||
- Set up the `JAVA_HOME` environment variable to point to the JDK home directory. It will contain
|
||||
the `bin`, `include`, and other directories.
|
||||
the `bin`, `include`, and other directories.
|
||||
|
||||
### Prepare the Device
|
||||
|
||||
- If using an emulator, use Android Studio to create and launch an Android Virtual Device (AVD).
|
||||
You may need to download the system images for the API level of the emulator you want to
|
||||
create. Using the AVD creation wizard in Android Studio is generally the easiest way to do all of
|
||||
this.
|
||||
You may need to download the system images for the API level of the emulator you want to
|
||||
create. Using the AVD creation wizard in Android Studio is generally the easiest way to do all of
|
||||
this.
|
||||
- If using a real device, you should [set it up for development and enable USB Debugging](https://developer.android.com/studio/debug/dev-options).
|
||||
- With the emulator or device connected, you can run `adb devices` (via the binary located at
|
||||
`$ANDROID_HOME/platform-tools/adb`) to verify that your device shows up as connected.
|
||||
`$ANDROID_HOME/platform-tools/adb`) to verify that your device shows up as connected.
|
||||
|
||||
Once your device shows up as connected in `adb`, and you've verified that the environment variables
|
||||
are set up correctly, you should be good to go! If you ran into problems with any of these steps,
|
||||
@@ -64,7 +64,7 @@ set up on your system, so you can get busy making Android apps if you want!
|
||||
|
||||
### Standard Install
|
||||
|
||||
Like all Appium drivers, the UiAutomator2 driver is installed via the [Appium Extension CLI](../cli/extensions.md).
|
||||
Like all Appium drivers, the UiAutomator2 driver is installed via the [Appium Extension CLI](../reference/cli/extensions.md).
|
||||
Since UiAutomator2 is maintained by the core Appium team, it has an 'official' driver name
|
||||
(`uiautomator2`), which makes the installation simpler.
|
||||
|
||||
@@ -92,7 +92,7 @@ must be used to select this driver for use during an Appium session (in this cas
|
||||
!!! note
|
||||
|
||||
```
|
||||
In this quickstart we have used the [Extension CLI](../cli/extensions.md) to install the
|
||||
In this quickstart we have used the [Extension CLI](../reference/cli/extensions.md) to install the
|
||||
UiAutomator2 driver, but if you are incorporating Appium into a Node.js project, you might
|
||||
prefer to use `npm` to manage Appium and its connected drivers. To learn more about this
|
||||
technique, visit the guide on [managing Appium extensions](../guides/managing-exts.md).
|
||||
@@ -112,7 +112,7 @@ Running this will install Appium's mobile-specific drivers: UiAutomator2, [XCUIT
|
||||
(only if running macOS), and [Espresso](https://github.com/appium/appium-espresso-driver).
|
||||
|
||||
You can also use this command to batch install drivers for desktop applications or desktop browsers.
|
||||
For more details on this, refer to the [Setup command documentation](../cli/setup.md).
|
||||
For more details on this, refer to the [Setup command documentation](../reference/cli/setup.md).
|
||||
|
||||
### Validating the Install
|
||||
|
||||
|
||||
@@ -51,10 +51,8 @@ Returns capabilities for the session and event history (if applicable).
|
||||
|
||||
!!! warning "Deprecated"
|
||||
|
||||
```
|
||||
Please use `getAppiumSessionCapabilities` to get the session capabilities.
|
||||
Please use `getLogEvents` to get event history.
|
||||
```
|
||||
Please use `getAppiumSessionCapabilities` to get the session capabilities.
|
||||
Please use `getLogEvents` to get event history.
|
||||
|
||||
<!-- comment source: multiple -->
|
||||
|
||||
@@ -316,7 +314,7 @@ A list of session data objects, where each object contains 3 keys:
|
||||
- `created`: the session creation time as a Unix timestamp in milliseconds
|
||||
- `capabilities`: the session capabilities
|
||||
|
||||
Data is only returned if the `session_discovery` [insecure feature](../guides/security.md)
|
||||
Data is only returned if the `session_discovery` [insecure feature](../../guides/security.md)
|
||||
is enabled on the server.
|
||||
|
||||
#### Example
|
||||
25
packages/appium/docs/ja/reference/api/index.md
Normal file
25
packages/appium/docs/ja/reference/api/index.md
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: API Endpoints
|
||||
---
|
||||
|
||||
Here you can find various API endpoints exposed by the main Appium module through its base driver,
|
||||
as well as the endpoints added or modified by official plugins.
|
||||
|
||||
Since all Appium drivers inherit the Appium base driver, they support all of its endpoints as well,
|
||||
but may additionally define endpoints of their own. Refer to the documentation of your
|
||||
[Appium driver](../../ecosystem/drivers.md) to learn about its specific endpoints.
|
||||
|
||||
The recommended way of calling these API endpoints is through your [Appium client](../../ecosystem/clients.md).
|
||||
Refer to the documentation of your client for the exact commands used to invoke specific endpoints.
|
||||
|
||||
The endpoint listings are as follows:
|
||||
|
||||
- [Base Driver](./base-driver.md)
|
||||
- [Execute Driver Plugin](./execute-driver-plugin.md)
|
||||
- [Images Plugin](./images-plugin.md)
|
||||
- [Relaxed Caps Plugin](./relaxed-caps-plugin.md)
|
||||
- [Storage Plugin](./storage-plugin.md)
|
||||
- [Universal XML Plugin](./universal-xml-plugin.md)
|
||||
@@ -14,24 +14,22 @@ below.
|
||||
|
||||
!!! note
|
||||
|
||||
```
|
||||
All of these arguments can be set via a [Configuration File](../guides/config.md) instead if
|
||||
you want. Any arguments set on the command line will override any arguments found in
|
||||
a configuration file.
|
||||
```
|
||||
All of these arguments can be set via a [Configuration File](../../guides/config.md) instead if
|
||||
you want. Any arguments set on the command line will override any arguments found in
|
||||
a configuration file.
|
||||
|
||||
| <div style="width:12em">Argument</div> | Description | Type | <div style="width:8em">Default</div> | Aliases |
|
||||
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------ | ------- |
|
||||
| `--address` | IP address to listen on | string | `0.0.0.0` | `-a` |
|
||||
| `--allow-cors` | Whether the Appium server should allow web browser connections from any host | boolean | `false` | |
|
||||
| `--allow-insecure` | Set which [insecure features](../guides/security.md) are allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. Individual features can be overridden by `--deny-insecure`. Has no effect in combination with `--relaxed-security`. | array<string> | `[]` | |
|
||||
| `--allow-insecure` | Set which [insecure features](../../guides/security.md) are allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. Individual features can be overridden by `--deny-insecure`. Has no effect in combination with `--relaxed-security`. | array<string> | `[]` | |
|
||||
| `--base-path` | Base path to use as the prefix for all webdriver routes running on the server | string | `""` | `-pa` |
|
||||
| `--callback-address` | Callback IP address (default: same as `--address`) | string | | `-ca` |
|
||||
| `--callback-port` | Callback port (default: same as `--port`) (Value must be between `1` and `65535`) | integer | `4723` | `-cp` |
|
||||
| `--config` | Path to an [Appium configuration JSON file](../guides/config.md) | string | | |
|
||||
| `--config` | Path to an [Appium configuration JSON file](../../guides/config.md) | string | | |
|
||||
| `--debug-log-spacing` | Add exaggerated spacing in logs to help with visual inspection | boolean | `false` | |
|
||||
| `--default-capabilities` | Set the default desired capabilities, which will be set on each session unless overridden by received capabilities. If a string, a path to a JSON file containing the capabilities, or raw JSON. | object | | `-dc` |
|
||||
| `--deny-insecure` | Set which [insecure features](../guides/security.md) are not allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. 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> | `[]` | |
|
||||
| `--deny-insecure` | Set which [insecure features](../../guides/security.md) are not allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. Since all insecure features are disabled by default, this argument has no effect without either `--allow-insecure` or `--relaxed-security`, and is applied after both. | array<string> | `[]` | |
|
||||
| `--driver` | Driver-specific configuration. Keys should correspond to driver package names | object | | |
|
||||
| `--drivers-import-chunk-size` | The maximum amount of drivers that could be imported in parallel on server startup | number | `3` | |
|
||||
| `--keep-alive-timeout` | Number of seconds the Appium server should apply as both the keep-alive timeout and the connection timeout for all requests. Setting this to `0` disables the timeout. | integer | `600` | `-ka` |
|
||||
@@ -49,10 +47,10 @@ a configuration file.
|
||||
| `--plugin` | Plugin-specific configuration. Keys should correspond to plugin package names | object | | |
|
||||
| `--plugins-import-chunk-size` | The maximum amount of plugins that could be imported in parallel on server startup | number | `7` | |
|
||||
| `--port` | Port to listen on (Value must be between `1` and `65535`) | integer | `4723` | `-p` |
|
||||
| `--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` | |
|
||||
| `--relaxed-security` | Allow all [insecure features](../../guides/security.md). Only use this if all clients are in a trusted network and could not potentially break out of the session sandbox. Specific features can be overridden by using `--deny-insecure`. | boolean | `false` | |
|
||||
| `--session-override` | Enables session override (clobbering) | boolean | `false` | |
|
||||
| `--ssl-cert-path` | Absolute path to the `.cert` file if TLS is used. Must be provided together with `--ssl-key-path`. See the [SSL/TLS/SPDY Support guide](../guides/tls.md) for details | string | | |
|
||||
| `--ssl-key-path` | Absolute path to the `.key` file if TLS is used. Must be provided together with `--ssl-cert-path`. See the [SSL/TLS/SPDY Support guide](../guides/tls.md) for details | string | | |
|
||||
| `--ssl-cert-path` | Absolute path to the `.cert` file if TLS is used. Must be provided together with `--ssl-key-path`. See the [SSL/TLS/SPDY Support guide](../../guides/tls.md) for details | string | | |
|
||||
| `--ssl-key-path` | Absolute path to the `.key` file if TLS is used. Must be provided together with `--ssl-cert-path`. See the [SSL/TLS/SPDY Support guide](../../guides/tls.md) for details | string | | |
|
||||
| `--strict-caps` | Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device | boolean | `false` | |
|
||||
| `--tmp` | Absolute path to directory Appium can use to manage temp files | string | Windows: `C:\Windows\Temp`<br>Others: `/tmp` | |
|
||||
| `--trace-dir` | Absolute path to directory Appium can use to save iOS instrument traces | string | `<tmp>/appium-instruments` | |
|
||||
@@ -10,15 +10,15 @@ advanced features are toggled or configured via environment variables. To set en
|
||||
variables, refer to the documentation for your operating system and terminal. These are the
|
||||
environment variables that the Appium server understands:
|
||||
|
||||
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `APPIUM_HOME` | By default, Appium creates a directory called `.appium` in the home directory for your system user. You can adjust the directory with this variable, as detailed in the [Managing Extensions](../guides/managing-exts.md) guide. |
|
||||
| `APPIUM_TMP_DIR` | By default, Appium uses a random temporary directory for many of its operations. If you wish to use a specific directory, you may do so by including an absolute path as the value of this variable. The behaviour is equivalent to using the `--tmp` CLI arg. |
|
||||
| `APPIUM_PREFER_SYSTEM_UNZIP` | Set to `0` or `false` to request that Appium not use the `unzip` binary included on your system for unzipping downloaded apps or other artifacts. Instead it will use a JS-based unzip library. This could help on some systems with non-existent or non-standard `unzip` commands. Note that if unzipping fails using the system library, the fallback library will be attempted in any case, so setting this env var merely saves time in the event you know the system unzip will fail. |
|
||||
| `APPIUM_HOST` | Same as the `--address` CLI arg |
|
||||
| `APPIUM_PORT` | Same as the `--port` CLI arg |
|
||||
| `APPIUM_RELOAD_EXTENSIONS` | Set to `1` to cause Appium to re-require extensions when new sessions are created. This is mostly useful for [building extensions](../developing/build-drivers.md) |
|
||||
| `APPIUM_OMIT_PEER_DEPS` | Adds `--omit=peer` to all the NPM commands run internally by Appium. Mostly an internal feature. |
|
||||
| `APPIUM_APPS_CACHE_MAX_AGE` | Allows to set the maximum age (in minutes) for [cached applications](../guides/caching.md). The default value is `60 * 24` (24 hours). Do not set it to a lower number than the duration of a single session startup. |
|
||||
| `APPIUM_APPS_CACHE_MAX_ITEMS` | Allows to set the maximum amount of [cached applications](../guides/caching.md). The default value is `1024`. Do not set it to a lower number than the amount of apps in all parallel sessions per process. |
|
||||
| `APPIUM_APPS_CACHE_IGNORE_URL_QUERY` | If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys. See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713) for more details. Disabled by default. |
|
||||
| Variable | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `APPIUM_HOME` | By default, Appium creates a directory called `.appium` in the home directory for your system user. You can adjust the directory with this variable, as detailed in the [Managing Extensions](../../guides/managing-exts.md) guide. |
|
||||
| `APPIUM_TMP_DIR` | By default, Appium uses a random temporary directory for many of its operations. If you wish to use a specific directory, you may do so by including an absolute path as the value of this variable. The behaviour is equivalent to using the `--tmp` CLI arg. |
|
||||
| `APPIUM_PREFER_SYSTEM_UNZIP` | Set to `0` or `false` to request that Appium not use the `unzip` binary included on your system for unzipping downloaded apps or other artifacts. Instead it will use a JS-based unzip library. This could help on some systems with non-existent or non-standard `unzip` commands. Note that if unzipping fails using the system library, the fallback library will be attempted in any case, so setting this env var merely saves time in the event you know the system unzip will fail. |
|
||||
| `APPIUM_HOST` | Same as the `--address` CLI arg |
|
||||
| `APPIUM_PORT` | Same as the `--port` CLI arg |
|
||||
| `APPIUM_RELOAD_EXTENSIONS` | Set to `1` to cause Appium to re-require extensions when new sessions are created. This is mostly useful for [building extensions](../../developing/build-drivers.md) |
|
||||
| `APPIUM_OMIT_PEER_DEPS` | Adds `--omit=peer` to all the NPM commands run internally by Appium. Mostly an internal feature. |
|
||||
| `APPIUM_APPS_CACHE_MAX_AGE` | Allows to set the maximum age (in minutes) for [cached applications](../../guides/caching.md). The default value is `60 * 24` (24 hours). Do not set it to a lower number than the duration of a single session startup. |
|
||||
| `APPIUM_APPS_CACHE_MAX_ITEMS` | Allows to set the maximum amount of [cached applications](../../guides/caching.md). The default value is `1024`. Do not set it to a lower number than the amount of apps in all parallel sessions per process. |
|
||||
| `APPIUM_APPS_CACHE_IGNORE_URL_QUERY` | If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys. See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713) for more details. Disabled by default. |
|
||||
@@ -5,16 +5,14 @@ title: Extension Command-Line Usage
|
||||
Appium allows for the flexible installation and management of various _extensions_, such as _drivers_
|
||||
(which provide Appium with the capability to automate a given platform) and _plugins_ (which can
|
||||
augment or alter the way individual Appium commands work). For a conceptual understanding of these
|
||||
entities, please review the [Introduction](../intro/index.md).
|
||||
entities, please review the [Introduction](../../intro/index.md).
|
||||
|
||||
Management of drivers and plugins is handled by Appium's Extension CLI (command-line interface).
|
||||
|
||||
!!! note
|
||||
|
||||
```
|
||||
This reference uses placeholders to refer to various options. Anywhere you see one of these
|
||||
placeholders in the reference, ensure you replace it with the correct type of actual content.
|
||||
```
|
||||
This reference uses placeholders to refer to various options. Anywhere you see one of these
|
||||
placeholders in the reference, ensure you replace it with the correct type of actual content.
|
||||
|
||||
| Placeholder | Meaning |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
@@ -36,7 +34,7 @@ and tuned for human consumption.
|
||||
|
||||
Run doctor checks for the given extension, which validate whether the extension has its prerequisites
|
||||
configured correctly. Note that not all extensions include doctor checks. See the
|
||||
[Building Doctor Checks](../developing/build-doctor-checks.md) tutorial for more details on
|
||||
[Building Doctor Checks](../../developing/build-doctor-checks.md) tutorial for more details on
|
||||
how to create them.
|
||||
|
||||
Usage:
|
||||
@@ -110,27 +108,27 @@ by `npm install`:
|
||||
|
||||
- Install the latest XCUITest driver:
|
||||
|
||||
```
|
||||
appium driver install xcuitest
|
||||
```
|
||||
```
|
||||
appium driver install xcuitest
|
||||
```
|
||||
|
||||
- Install the XCUITest driver at version 4.11.1:
|
||||
|
||||
```
|
||||
appium driver install xcuitest@4.11.1
|
||||
```
|
||||
```
|
||||
appium driver install xcuitest@4.11.1
|
||||
```
|
||||
|
||||
- Install the `beta` version of the `@appium/fake-driver` from NPM:
|
||||
|
||||
```
|
||||
appium driver install --source=npm @appium/fake-driver@beta
|
||||
```
|
||||
```
|
||||
appium driver install --source=npm @appium/fake-driver@beta
|
||||
```
|
||||
|
||||
- Install a locally-developed plugin:
|
||||
|
||||
```
|
||||
appium plugin install --source=local /path/to/my/plugin
|
||||
```
|
||||
```
|
||||
appium plugin install --source=local /path/to/my/plugin
|
||||
```
|
||||
|
||||
### `list`
|
||||
|
||||
@@ -5,8 +5,8 @@ hide:
|
||||
title: Command Line Interface
|
||||
---
|
||||
|
||||
Appium provides a command-line executable (`appium`), which will likely be your main way of interacting with
|
||||
the Appium server. This section of the Appium documentation describes how to use this executable.
|
||||
Appium provides a command-line executable (`appium`), which can be used to configure and launch
|
||||
the Appium server, as well as manage drivers and plugins.
|
||||
|
||||
To start off, you can run `appium -v` or `appium --version` to return the installed version,
|
||||
or run `appium -h` or `appium --help` to return the help message.
|
||||
@@ -23,4 +23,5 @@ The main `appium` executable provides the following subcommands:
|
||||
4. `appium setup` - batch install a preset of drivers and plugins
|
||||
- [See here for details](./setup.md)
|
||||
|
||||
Like the main command, you can also run each subcommand with the `-h` or `--help` flag to learn more about it.
|
||||
Like the main command, you can also run each subcommand with the `-h` or `--help` flag to learn
|
||||
more about it.
|
||||
@@ -21,7 +21,7 @@ The presets are as follows:
|
||||
Attempting to install a preset while already having one or more of its included extensions installed
|
||||
will only install the missing extensions.
|
||||
|
||||
Refer to the [Ecosystem documentation](../ecosystem/index.md) to learn more about the extensions
|
||||
Refer to the [Ecosystem documentation](../../ecosystem/index.md) to learn more about the extensions
|
||||
listed above.
|
||||
|
||||
This commands also supports the functionality that allows to fully reset your Appium server
|
||||
25
packages/appium/docs/ja/reference/index.md
Normal file
25
packages/appium/docs/ja/reference/index.md
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Reference
|
||||
---
|
||||
|
||||
This section of the Appium documentation provides a reference to the two main interfaces within the
|
||||
Appium server: the command-line executable, and the supported API endpoints.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :octicons-command-palette-16: [**Command Line Interface**](./cli/index.md)
|
||||
|
||||
---
|
||||
|
||||
Learn how to use the Appium command-line executable
|
||||
|
||||
- :material-cloud-braces: [**API Endpoints**](./api/index.md)
|
||||
|
||||
---
|
||||
|
||||
View endpoints supported by the Appium server
|
||||
|
||||
</div>
|
||||
@@ -34,20 +34,22 @@ nav:
|
||||
- ecosystem/clients.md
|
||||
- ecosystem/plugins.md
|
||||
- ecosystem/tools.md
|
||||
- CLI リファレンス:
|
||||
- cli/index.md
|
||||
- cli/args.md
|
||||
- cli/env-vars.md
|
||||
- cli/extensions.md
|
||||
- cli/setup.md
|
||||
- コマンドリファレンス:
|
||||
- commands/index.md
|
||||
- commands/base-driver.md
|
||||
- commands/execute-driver-plugin.md
|
||||
- commands/images-plugin.md
|
||||
- commands/relaxed-caps-plugin.md
|
||||
- commands/storage-plugin.md
|
||||
- commands/universal-xml-plugin.md
|
||||
- Reference:
|
||||
- reference/index.md
|
||||
- Command Line Interface:
|
||||
- reference/cli/index.md
|
||||
- reference/cli/args.md
|
||||
- reference/cli/env-vars.md
|
||||
- reference/cli/extensions.md
|
||||
- reference/cli/setup.md
|
||||
- API Endpoints:
|
||||
- reference/api/index.md
|
||||
- reference/api/base-driver.md
|
||||
- reference/api/execute-driver-plugin.md
|
||||
- reference/api/images-plugin.md
|
||||
- reference/api/relaxed-caps-plugin.md
|
||||
- reference/api/storage-plugin.md
|
||||
- reference/api/universal-xml-plugin.md
|
||||
- ガイド:
|
||||
- 移行:
|
||||
- guides/migrating-2-to-3.md
|
||||
|
||||
@@ -34,20 +34,22 @@ nav:
|
||||
- ecosystem/clients.md
|
||||
- ecosystem/plugins.md
|
||||
- ecosystem/tools.md
|
||||
- 命令行参考:
|
||||
- cli/index.md
|
||||
- cli/args.md
|
||||
- cli/env-vars.md
|
||||
- cli/extensions.md
|
||||
- cli/setup.md
|
||||
- 命令参考:
|
||||
- commands/index.md
|
||||
- commands/base-driver.md
|
||||
- commands/execute-driver-plugin.md
|
||||
- commands/images-plugin.md
|
||||
- commands/relaxed-caps-plugin.md
|
||||
- commands/storage-plugin.md
|
||||
- commands/universal-xml-plugin.md
|
||||
- Reference:
|
||||
- reference/index.md
|
||||
- Command Line Interface:
|
||||
- reference/cli/index.md
|
||||
- reference/cli/args.md
|
||||
- reference/cli/env-vars.md
|
||||
- reference/cli/extensions.md
|
||||
- reference/cli/setup.md
|
||||
- API Endpoints:
|
||||
- reference/api/index.md
|
||||
- reference/api/base-driver.md
|
||||
- reference/api/execute-driver-plugin.md
|
||||
- reference/api/images-plugin.md
|
||||
- reference/api/relaxed-caps-plugin.md
|
||||
- reference/api/storage-plugin.md
|
||||
- reference/api/universal-xml-plugin.md
|
||||
- 指南:
|
||||
- 迁移:
|
||||
- guides/migrating-2-to-3.md
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Command Reference
|
||||
---
|
||||
|
||||
Here you can find various commands exposed by the main Appium module through its base driver, as
|
||||
well as the commands available in several plugins.
|
||||
|
||||
!!! note
|
||||
|
||||
```
|
||||
The Appium base driver only exposes a few commands, as it is not meant to be used on its own.
|
||||
Please refer to the documentation of your [Appium driver](../ecosystem/drivers.md) to learn
|
||||
about the commands it exposes, and then check your [Appium client](../ecosystem/clients.md)
|
||||
documentation for the exact syntax of that command.
|
||||
```
|
||||
|
||||
The command listings can be found here:
|
||||
|
||||
- [Base Driver](./base-driver.md)
|
||||
- [Execute Driver Plugin](./execute-driver-plugin.md)
|
||||
- [Images Plugin](./images-plugin.md)
|
||||
- [Inspector](https://github.com/appium/appium-inspector/tree/main/plugins)
|
||||
- [Relaxed Caps Plugin](./relaxed-caps-plugin.md)
|
||||
- [Storage Plugin](./storage-plugin.md)
|
||||
- [Universal XML Plugin](./universal-xml-plugin.md)
|
||||
@@ -29,7 +29,7 @@ Appium driver or plugin developers can choose to include these tools in their dr
|
||||
|
||||
The Appium Doctor tool can be used to validate whether all prerequisites and other environment
|
||||
details needed for the driver/plugin have been set up correctly. The tool can be accessed via the
|
||||
[`doctor` command in the Appium CLI](../cli/extensions.md#doctor):
|
||||
[`doctor` command in the Appium CLI](../reference/cli/extensions.md#doctor):
|
||||
|
||||
```sh
|
||||
appium {driver|plugin} doctor <extension-name>
|
||||
|
||||
@@ -28,16 +28,16 @@ In order to validate whether an app bundle downloaded from the given URL could b
|
||||
steps are applied:
|
||||
|
||||
1. The script checks if the given URL is already present in the cache.
|
||||
If yes then it tries to fetch previously remembered
|
||||
[Last-Modified](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified)
|
||||
or [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header values for it.
|
||||
If yes then it tries to fetch previously remembered
|
||||
[Last-Modified](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified)
|
||||
or [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header values for it.
|
||||
2. If `ETag` value is present then it is put into
|
||||
[If-None-Match request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match).
|
||||
Else if `Last-Modified` header value is present then it is put into
|
||||
[If-Modified-Since request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since).
|
||||
Otherwise, no caching is applied.
|
||||
[If-None-Match request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match).
|
||||
Else if `Last-Modified` header value is present then it is put into
|
||||
[If-Modified-Since request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since).
|
||||
Otherwise, no caching is applied.
|
||||
3. If the response status is equal to `304` then the previously cached binary is used,
|
||||
otherwise the cached entry is reset and refreshed.
|
||||
otherwise the cached entry is reset and refreshed.
|
||||
|
||||
## Caching of Local Application Bundles
|
||||
|
||||
@@ -45,9 +45,9 @@ It only makes sense to cache application bundles if they need some preprocessing
|
||||
For example, on iOS `.ipa` bundles must be unzipped, because the system installer only works with `.app` folders.
|
||||
|
||||
1. The script verifies if the given bundle path is already present in the cache. If the bundle was not in the cache yet
|
||||
then it gets preprocessed and added there.
|
||||
then it gets preprocessed and added there.
|
||||
2. The script validates the hashsum of the bundle and compares it to the previously stored one. If hash sums don't match
|
||||
then the cached item gets deleted and the preprocessing of the bundle repeats.
|
||||
then the cached item gets deleted and the preprocessing of the bundle repeats.
|
||||
|
||||
## How The Cache File System Is Configured
|
||||
|
||||
@@ -56,15 +56,15 @@ on per-process basis, so each test session initialized in scope of the same Appi
|
||||
of it. It is a [LRU Cache](https://www.npmjs.com/package/lru-cache) with the following limitations:
|
||||
|
||||
- Max items: 1024. You may customize it by providing a new value to
|
||||
the [APPIUM_APPS_CACHE_MAX_ITEMS](../cli/env-vars.md) environment variable.
|
||||
the [APPIUM_APPS_CACHE_MAX_ITEMS](../reference/cli/env-vars.md) environment variable.
|
||||
Do not set it to a lower number than the amount of apps in all parallel sessions per process.
|
||||
- Max time to live (TTL) for each entry: 24 hours.
|
||||
You may customize it by providing a new value to the
|
||||
[APPIUM_APPS_CACHE_MAX_AGE](../cli/env-vars.md) environment variable.
|
||||
[APPIUM_APPS_CACHE_MAX_AGE](../reference/cli/env-vars.md) environment variable.
|
||||
Do not set it to a lower number than the duration of a single session startup.
|
||||
- TTL is refreshed for each entry upon access
|
||||
- By default the full application URL is used as cache key. You may change this behavior
|
||||
by enabling the [APPIUM_APPS_CACHE_IGNORE_URL_QUERY](../cli/env-vars.md) environment variable.
|
||||
by enabling the [APPIUM_APPS_CACHE_IGNORE_URL_QUERY](../reference/cli/env-vars.md) environment variable.
|
||||
If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys.
|
||||
See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713)
|
||||
for more details.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Retrieving Event Timings
|
||||
---
|
||||
|
||||
@@ -69,6 +70,6 @@ In the past, events were available as a part of `GET /session/:id` response
|
||||
## Add a custom event
|
||||
|
||||
You can add custom events that will show up in the event timings data. You can send a custom event
|
||||
name to the Appium server using the [Log Custom Event API](../commands/base-driver.md#logcustomevent),
|
||||
and the server will store the timestamp. The [Get Log Events](../commands/base-driver.md#getlogevents)
|
||||
name to the Appium server using the [Log Custom Event API](../reference/api/base-driver.md#logcustomevent),
|
||||
and the server will store the timestamp. The [Get Log Events](../reference/api/base-driver.md#getlogevents)
|
||||
command can be used to retrieve named events' timestamps later on.
|
||||
|
||||
@@ -18,7 +18,7 @@ Other package managers are not currently supported.
|
||||
|
||||
## Using Appium's Extension CLI
|
||||
|
||||
With Appium's [Extension CLI](../cli/extensions.md), you let Appium manage drivers and plugins for
|
||||
With Appium's [Extension CLI](../reference/cli/extensions.md), you let Appium manage drivers and plugins for
|
||||
you. You will use CLI commands to tell Appium which extensions you would like to install, update,
|
||||
or remove. Here's an example of how you might install a driver using the CLI:
|
||||
|
||||
@@ -64,9 +64,9 @@ like any other dependency. Basically, whenever you run Appium, if you have not e
|
||||
|
||||
1. Try to determine whether the _current directory_ is inside an `npm` package.
|
||||
2. If so, it will check whether `appium` is a dependency (dev, prod, or peer) in the project's
|
||||
`package.json`
|
||||
`package.json`
|
||||
3. If so, _unless you have specified `APPIUM_HOME` in your environment_, Appium will ignore load
|
||||
drivers and plugins defined in that `package.json` file instead.
|
||||
drivers and plugins defined in that `package.json` file instead.
|
||||
|
||||
This means you are freely able to add Appium drivers and plugins as regular package dependencies or
|
||||
dev dependencies. For example, if your project has a `package.json` which includes the following:
|
||||
|
||||
@@ -37,13 +37,13 @@ When it comes to installing Appium 2 drivers, there are several approaches you c
|
||||
npm i -g appium --drivers=xcuitest,uiautomator2
|
||||
```
|
||||
|
||||
- Use the [Appium Extension CLI](../cli/extensions.md), for example:
|
||||
- Use the [Appium Extension CLI](../reference/cli/extensions.md), for example:
|
||||
|
||||
```bash
|
||||
appium driver install uiautomator2
|
||||
```
|
||||
|
||||
- Use the [Appium Setup CLI command](../cli/setup.md) (added in Appium `2.6`), for example:
|
||||
- Use the [Appium Setup CLI command](../reference/cli/setup.md) (added in Appium `2.6`), for example:
|
||||
|
||||
```bash
|
||||
appium setup mobile
|
||||
@@ -82,7 +82,7 @@ server and drivers are separate packages, they can release new versions independ
|
||||
other - this means that you no longer need to wait for a new Appium server release, but can install
|
||||
the latest driver versions right away.
|
||||
|
||||
Checking for driver updates is done by using the [Appium Extension CLI](../cli/extensions.md):
|
||||
Checking for driver updates is done by using the [Appium Extension CLI](../reference/cli/extensions.md):
|
||||
|
||||
```bash
|
||||
appium driver list --updates
|
||||
@@ -106,7 +106,7 @@ server package.
|
||||
!!! info "Actions Needed"
|
||||
|
||||
```
|
||||
Make sure to use the [Appium Extension CLI](../cli/extensions.md) to manage your drivers
|
||||
Make sure to use the [Appium Extension CLI](../reference/cli/extensions.md) to manage your drivers
|
||||
```
|
||||
|
||||
### Deprecated Packages No Longer Supported
|
||||
@@ -139,7 +139,7 @@ path to `/`, therefore the default server URL is now `http://localhost:4723/`.
|
||||
```
|
||||
In your test scripts, change the base path of the target server URL from `/wd/hub` to `/`.
|
||||
Alternatively, you can retain the Appium 1 base path by launching Appium with the
|
||||
`--base-path=/wd/hub` [command-line argument](../cli/args.md).
|
||||
`--base-path=/wd/hub` [command-line argument](../reference/cli/args.md).
|
||||
```
|
||||
|
||||
### Server Port 0 No Longer Supported
|
||||
@@ -178,8 +178,7 @@ appium --chromedriver-version=100 # Appium 1
|
||||
CHROMEDRIVER_VERSION=100 appium # Appium 2
|
||||
```
|
||||
|
||||
- Some options can now be passed as [capabilities](https://appium.io/docs/en/latest/guides/caps/),
|
||||
for example:
|
||||
- Some options can now be passed as [capabilities](./caps.md), for example:
|
||||
|
||||
```
|
||||
appium --chromedriver-executable=/path/to/chromedriver # Appium 1
|
||||
@@ -208,8 +207,8 @@ Appium 2 no longer attempts to parse the contents of filepaths passed to these o
|
||||
two ways to specify the value for these options:
|
||||
|
||||
- As strings, directly on the command line
|
||||
- `--nodeconfig` / `--default-capabilities`: JSON string
|
||||
- `--allow-insecure` / `--deny-insecure`: comma-separated list
|
||||
- `--nodeconfig` / `--default-capabilities`: JSON string
|
||||
- `--allow-insecure` / `--deny-insecure`: comma-separated list
|
||||
- In the [Appium Configuration file](./config.md)
|
||||
|
||||
!!! info "Actions Needed"
|
||||
@@ -345,14 +344,14 @@ support for these parameters. The following is a list of these changed endpoints
|
||||
parameters they no longer accept, as well as the parameters they continue to accept in Appium 2.
|
||||
|
||||
- `POST /session/:sessionId/appium/device/gsm_signal`
|
||||
- :octicons-x-24: `signalStrengh`
|
||||
- :octicons-check-24: `signalStrength`
|
||||
- :octicons-x-24: `signalStrengh`
|
||||
- :octicons-check-24: `signalStrength`
|
||||
- `POST /session/:sessionId/appium/element/:elementId/value`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
- `POST /session/:sessionId/appium/element/:elementId/replace_value`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
- :octicons-x-24: `value`
|
||||
- :octicons-check-24: `text`
|
||||
|
||||
!!! info "Actions Needed"
|
||||
|
||||
@@ -387,7 +386,7 @@ wish to take advantage of with Appium 2:
|
||||
|
||||
You are no longer limited to official drivers or plugins, or ones that the Appium team even knows
|
||||
about! Developers can now create their own custom drivers or plugins, which can be installed via
|
||||
Appium's [Extension CLI](../cli/extensions.md) from `npm`, `git`, GitHub, or even the local
|
||||
Appium's [Extension CLI](../reference/cli/extensions.md) from `npm`, `git`, GitHub, or even the local
|
||||
filesystem. Interested in building a driver or plugin? Check out the
|
||||
[Building Drivers](../developing/build-drivers.md) and
|
||||
[Building Plugins](../developing/build-plugins.md) guides.
|
||||
|
||||
@@ -22,7 +22,7 @@ this is the responsibility of the server admin who configures and launches the A
|
||||
|
||||
## Security Server Args
|
||||
|
||||
The [Server CLI Args](../cli/args.md) doc outlines three relevant arguments which may be passed to
|
||||
The [Server CLI Args](../reference/cli/args.md) doc outlines three relevant arguments which may be passed to
|
||||
Appium when starting it from the command line:
|
||||
|
||||
| <div style="width:10em">Parameter</div> | Description |
|
||||
|
||||
@@ -44,11 +44,11 @@ title: 欢迎使用
|
||||
- 查看 [**简介**](./intro/index.md) 以确保您理解关键概念
|
||||
- 通过 [**快速开始**](./quickstart/index.md) 来设置并运行一个基本的 Android 测试
|
||||
- 访问 [**生态系统**](./ecosystem/index.md) 页面，获取您可能想要使用的驱动程序、客户端和插件列表
|
||||
- 阅读 [**命令行参考**](./cli/index.md) 了解Appium的命令行使用方法
|
||||
- 阅读 [**命令参考**](./commands/index.md) 了解Appium和插件的可用命令列表
|
||||
- Consult the [**Reference**](./reference/index.md) page for information on the Appium CLI and supported endpoints
|
||||
- Read the different [**Guides**](./guides/migrating-2-to-3.md) for a variety of instructions, tips and tricks
|
||||
- Check out various third-party [**Resources**](./resources/index.md) to explore Appium around the web
|
||||
- 要创建自己的 Appium 扩展，请参阅 [**开发者**](./developing/index.md) 文档
|
||||
- For contributions to Appium itself, refer to the [**Contributing**](./contributing/index.md) page
|
||||
- Have a look at the [**Appium Blog**](./blog/index.md) to learn what's new in the project
|
||||
|
||||
</div>
|
||||
|
||||
@@ -189,9 +189,9 @@ will never have time to build. And so, with Appium 2, Appium has released a plug
|
||||
enables anyone to build and share modules that change how Appium works!
|
||||
|
||||
In the same way that drivers are easily shareable and consumable via the Appium driver CLI, plugins
|
||||
can be published and consumed via a parallel [Plugin CLI](../cli/extensions.md). Plugins can do all
|
||||
sorts of things, for example adding the ability for Appium to find and interact with screen regions
|
||||
based on a template image (as in the images). There are very few
|
||||
can be published and consumed via a parallel [Plugin CLI](../reference/cli/extensions.md). Plugins
|
||||
can do all sorts of things, for example adding the ability for Appium to find and interact with
|
||||
screen regions based on a template image (as in the images). There are very few
|
||||
limitations on what you can do with plugins, so you might also be interested in learning how to
|
||||
[Build Plugins](../developing/build-plugins.md) in Node.js that can be used with Appium.
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Install Appium
|
||||
---
|
||||
|
||||
@@ -24,7 +25,7 @@ Other package managers are not currently supported.
|
||||
|
||||
## Starting Appium
|
||||
|
||||
Appium can be started [using the command line](../cli/index.md):
|
||||
Appium can be started [using the command line](../reference/cli/index.md):
|
||||
|
||||
```
|
||||
appium
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: System Requirements
|
||||
---
|
||||
|
||||
@@ -25,4 +26,4 @@ require the developer toolchain and SDKs for that platform to be installed.
|
||||
|
||||
In order to assist with driver requirements, each (official) driver comes with the Appium Doctor tool,
|
||||
which allows to verify if all requirements have been set up. Learn more about how to use this tool in
|
||||
the [Command-Line Usage documentation](../cli/extensions.md#doctor).
|
||||
the [Command-Line Usage documentation](../reference/cli/extensions.md#doctor).
|
||||
|
||||
@@ -24,34 +24,34 @@ According to the driver, in addition to a working Appium server, we also need to
|
||||
### Android SDK
|
||||
|
||||
- The easiest way to set up the Android SDK requirements is by downloading [Android Studio](https://developer.android.com/studio).
|
||||
We need to use its SDK manager (_Settings -> Languages & Frameworks -> Android SDK_)
|
||||
to download the following items:
|
||||
- Android SDK Platform (select whichever Android platform we want to automate, for example, API level 30)
|
||||
- Android SDK Platform-Tools
|
||||
We need to use its SDK manager (_Settings -> Languages & Frameworks -> Android SDK_)
|
||||
to download the following items:
|
||||
- Android SDK Platform (select whichever Android platform we want to automate, for example, API level 30)
|
||||
- Android SDK Platform-Tools
|
||||
- If you wish, you can also download these items without Android Studio:
|
||||
- Android SDK Platform can be downloaded using `sdkmanager` included in [Android command-line tools](https://developer.android.com/studio#command-line-tools-only)
|
||||
- [Android SDK Platform-Tools](https://developer.android.com/tools/releases/platform-tools)
|
||||
- Android SDK Platform can be downloaded using `sdkmanager` included in [Android command-line tools](https://developer.android.com/studio#command-line-tools-only)
|
||||
- [Android SDK Platform-Tools](https://developer.android.com/tools/releases/platform-tools)
|
||||
- Set up the `ANDROID_HOME` environment variable to point to the directory where the Android SDK is
|
||||
installed. You can usually find the path to this directory in the Android Studio SDK manager. It
|
||||
will contain the `platform-tools` and other directories.
|
||||
installed. You can usually find the path to this directory in the Android Studio SDK manager. It
|
||||
will contain the `platform-tools` and other directories.
|
||||
|
||||
### Java JDK
|
||||
|
||||
- Install the Java JDK (for the most recent Android API levels, JDK 9 is required, otherwise JDK
|
||||
8 is required). You can download this from [Oracle](https://jdk.java.net/) or [Adoptium](https://adoptium.net/en-GB/temurin/releases/).
|
||||
Make sure you get the JDK and not the JRE.
|
||||
8 is required). You can download this from [Oracle](https://jdk.java.net/) or [Adoptium](https://adoptium.net/en-GB/temurin/releases/).
|
||||
Make sure you get the JDK and not the JRE.
|
||||
- Set up the `JAVA_HOME` environment variable to point to the JDK home directory. It will contain
|
||||
the `bin`, `include`, and other directories.
|
||||
the `bin`, `include`, and other directories.
|
||||
|
||||
### Prepare the Device
|
||||
|
||||
- If using an emulator, use Android Studio to create and launch an Android Virtual Device (AVD).
|
||||
You may need to download the system images for the API level of the emulator you want to
|
||||
create. Using the AVD creation wizard in Android Studio is generally the easiest way to do all of
|
||||
this.
|
||||
You may need to download the system images for the API level of the emulator you want to
|
||||
create. Using the AVD creation wizard in Android Studio is generally the easiest way to do all of
|
||||
this.
|
||||
- If using a real device, you should [set it up for development and enable USB Debugging](https://developer.android.com/studio/debug/dev-options).
|
||||
- With the emulator or device connected, you can run `adb devices` (via the binary located at
|
||||
`$ANDROID_HOME/platform-tools/adb`) to verify that your device shows up as connected.
|
||||
`$ANDROID_HOME/platform-tools/adb`) to verify that your device shows up as connected.
|
||||
|
||||
Once your device shows up as connected in `adb`, and you've verified that the environment variables
|
||||
are set up correctly, you should be good to go! If you ran into problems with any of these steps,
|
||||
@@ -64,7 +64,7 @@ set up on your system, so you can get busy making Android apps if you want!
|
||||
|
||||
### Standard Install
|
||||
|
||||
Like all Appium drivers, the UiAutomator2 driver is installed via the [Appium Extension CLI](../cli/extensions.md).
|
||||
Like all Appium drivers, the UiAutomator2 driver is installed via the [Appium Extension CLI](../reference/cli/extensions.md).
|
||||
Since UiAutomator2 is maintained by the core Appium team, it has an 'official' driver name
|
||||
(`uiautomator2`), which makes the installation simpler.
|
||||
|
||||
@@ -92,7 +92,7 @@ must be used to select this driver for use during an Appium session (in this cas
|
||||
!!! note
|
||||
|
||||
```
|
||||
In this quickstart we have used the [Extension CLI](../cli/extensions.md) to install the
|
||||
In this quickstart we have used the [Extension CLI](../reference/cli/extensions.md) to install the
|
||||
UiAutomator2 driver, but if you are incorporating Appium into a Node.js project, you might
|
||||
prefer to use `npm` to manage Appium and its connected drivers. To learn more about this
|
||||
technique, visit the guide on [managing Appium extensions](../guides/managing-exts.md).
|
||||
@@ -112,7 +112,7 @@ Running this will install Appium's mobile-specific drivers: UiAutomator2, [XCUIT
|
||||
(only if running macOS), and [Espresso](https://github.com/appium/appium-espresso-driver).
|
||||
|
||||
You can also use this command to batch install drivers for desktop applications or desktop browsers.
|
||||
For more details on this, refer to the [Setup command documentation](../cli/setup.md).
|
||||
For more details on this, refer to the [Setup command documentation](../reference/cli/setup.md).
|
||||
|
||||
### Validating the Install
|
||||
|
||||
|
||||
@@ -51,10 +51,8 @@ Returns capabilities for the session and event history (if applicable).
|
||||
|
||||
!!! warning "Deprecated"
|
||||
|
||||
```
|
||||
Please use `getAppiumSessionCapabilities` to get the session capabilities.
|
||||
Please use `getLogEvents` to get event history.
|
||||
```
|
||||
Please use `getAppiumSessionCapabilities` to get the session capabilities.
|
||||
Please use `getLogEvents` to get event history.
|
||||
|
||||
<!-- comment source: multiple -->
|
||||
|
||||
@@ -316,7 +314,7 @@ A list of session data objects, where each object contains 3 keys:
|
||||
- `created`: the session creation time as a Unix timestamp in milliseconds
|
||||
- `capabilities`: the session capabilities
|
||||
|
||||
Data is only returned if the `session_discovery` [insecure feature](../guides/security.md)
|
||||
Data is only returned if the `session_discovery` [insecure feature](../../guides/security.md)
|
||||
is enabled on the server.
|
||||
|
||||
#### Example
|
||||
25
packages/appium/docs/zh/reference/api/index.md
Normal file
25
packages/appium/docs/zh/reference/api/index.md
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: API Endpoints
|
||||
---
|
||||
|
||||
Here you can find various API endpoints exposed by the main Appium module through its base driver,
|
||||
as well as the endpoints added or modified by official plugins.
|
||||
|
||||
Since all Appium drivers inherit the Appium base driver, they support all of its endpoints as well,
|
||||
but may additionally define endpoints of their own. Refer to the documentation of your
|
||||
[Appium driver](../../ecosystem/drivers.md) to learn about its specific endpoints.
|
||||
|
||||
The recommended way of calling these API endpoints is through your [Appium client](../../ecosystem/clients.md).
|
||||
Refer to the documentation of your client for the exact commands used to invoke specific endpoints.
|
||||
|
||||
The endpoint listings are as follows:
|
||||
|
||||
- [Base Driver](./base-driver.md)
|
||||
- [Execute Driver Plugin](./execute-driver-plugin.md)
|
||||
- [Images Plugin](./images-plugin.md)
|
||||
- [Relaxed Caps Plugin](./relaxed-caps-plugin.md)
|
||||
- [Storage Plugin](./storage-plugin.md)
|
||||
- [Universal XML Plugin](./universal-xml-plugin.md)
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Server Command-Line Arguments
|
||||
---
|
||||
|
||||
@@ -13,24 +14,22 @@ below.
|
||||
|
||||
!!! note
|
||||
|
||||
```
|
||||
All of these arguments can be set via a [Configuration File](../guides/config.md) instead if
|
||||
you want. Any arguments set on the command line will override any arguments found in
|
||||
a configuration file.
|
||||
```
|
||||
All of these arguments can be set via a [Configuration File](../../guides/config.md) instead if
|
||||
you want. Any arguments set on the command line will override any arguments found in
|
||||
a configuration file.
|
||||
|
||||
| <div style="width:12em">Argument</div> | Description | Type | <div style="width:8em">Default</div> | Aliases |
|
||||
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------ | ------- |
|
||||
| `--address` | IP address to listen on | string | `0.0.0.0` | `-a` |
|
||||
| `--allow-cors` | Whether the Appium server should allow web browser connections from any host | boolean | `false` | |
|
||||
| `--allow-insecure` | Set which [insecure features](../guides/security.md) are allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. Individual features can be overridden by `--deny-insecure`. Has no effect in combination with `--relaxed-security`. | array<string> | `[]` | |
|
||||
| `--allow-insecure` | Set which [insecure features](../../guides/security.md) are allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. Individual features can be overridden by `--deny-insecure`. Has no effect in combination with `--relaxed-security`. | array<string> | `[]` | |
|
||||
| `--base-path` | Base path to use as the prefix for all webdriver routes running on the server | string | `""` | `-pa` |
|
||||
| `--callback-address` | Callback IP address (default: same as `--address`) | string | | `-ca` |
|
||||
| `--callback-port` | Callback port (default: same as `--port`) (Value must be between `1` and `65535`) | integer | `4723` | `-cp` |
|
||||
| `--config` | Path to an [Appium configuration JSON file](../guides/config.md) | string | | |
|
||||
| `--config` | Path to an [Appium configuration JSON file](../../guides/config.md) | string | | |
|
||||
| `--debug-log-spacing` | Add exaggerated spacing in logs to help with visual inspection | boolean | `false` | |
|
||||
| `--default-capabilities` | Set the default desired capabilities, which will be set on each session unless overridden by received capabilities. If a string, a path to a JSON file containing the capabilities, or raw JSON. | object | | `-dc` |
|
||||
| `--deny-insecure` | Set which [insecure features](../guides/security.md) are not allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. 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> | `[]` | |
|
||||
| `--deny-insecure` | Set which [insecure features](../../guides/security.md) are not allowed to run in this server's sessions. Most features are defined on a driver level; see driver documentation for more details. Since all insecure features are disabled by default, this argument has no effect without either `--allow-insecure` or `--relaxed-security`, and is applied after both. | array<string> | `[]` | |
|
||||
| `--driver` | Driver-specific configuration. Keys should correspond to driver package names | object | | |
|
||||
| `--drivers-import-chunk-size` | The maximum amount of drivers that could be imported in parallel on server startup | number | `3` | |
|
||||
| `--keep-alive-timeout` | Number of seconds the Appium server should apply as both the keep-alive timeout and the connection timeout for all requests. Setting this to `0` disables the timeout. | integer | `600` | `-ka` |
|
||||
@@ -48,10 +47,10 @@ a configuration file.
|
||||
| `--plugin` | Plugin-specific configuration. Keys should correspond to plugin package names | object | | |
|
||||
| `--plugins-import-chunk-size` | The maximum amount of plugins that could be imported in parallel on server startup | number | `7` | |
|
||||
| `--port` | Port to listen on (Value must be between `1` and `65535`) | integer | `4723` | `-p` |
|
||||
| `--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` | |
|
||||
| `--relaxed-security` | Allow all [insecure features](../../guides/security.md). Only use this if all clients are in a trusted network and could not potentially break out of the session sandbox. Specific features can be overridden by using `--deny-insecure`. | boolean | `false` | |
|
||||
| `--session-override` | Enables session override (clobbering) | boolean | `false` | |
|
||||
| `--ssl-cert-path` | Absolute path to the `.cert` file if TLS is used. Must be provided together with `--ssl-key-path`. See the [SSL/TLS/SPDY Support guide](../guides/tls.md) for details | string | | |
|
||||
| `--ssl-key-path` | Absolute path to the `.key` file if TLS is used. Must be provided together with `--ssl-cert-path`. See the [SSL/TLS/SPDY Support guide](../guides/tls.md) for details | string | | |
|
||||
| `--ssl-cert-path` | Absolute path to the `.cert` file if TLS is used. Must be provided together with `--ssl-key-path`. See the [SSL/TLS/SPDY Support guide](../../guides/tls.md) for details | string | | |
|
||||
| `--ssl-key-path` | Absolute path to the `.key` file if TLS is used. Must be provided together with `--ssl-cert-path`. See the [SSL/TLS/SPDY Support guide](../../guides/tls.md) for details | string | | |
|
||||
| `--strict-caps` | Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device | boolean | `false` | |
|
||||
| `--tmp` | Absolute path to directory Appium can use to manage temp files | string | Windows: `C:\Windows\Temp`<br>Others: `/tmp` | |
|
||||
| `--trace-dir` | Absolute path to directory Appium can use to save iOS instrument traces | string | `<tmp>/appium-instruments` | |
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Server Environment Variables
|
||||
---
|
||||
|
||||
@@ -9,15 +10,15 @@ advanced features are toggled or configured via environment variables. To set en
|
||||
variables, refer to the documentation for your operating system and terminal. These are the
|
||||
environment variables that the Appium server understands:
|
||||
|
||||
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `APPIUM_HOME` | By default, Appium creates a directory called `.appium` in the home directory for your system user. You can adjust the directory with this variable, as detailed in the [Managing Extensions](../guides/managing-exts.md) guide. |
|
||||
| `APPIUM_TMP_DIR` | By default, Appium uses a random temporary directory for many of its operations. If you wish to use a specific directory, you may do so by including an absolute path as the value of this variable. The behaviour is equivalent to using the `--tmp` CLI arg. |
|
||||
| `APPIUM_PREFER_SYSTEM_UNZIP` | Set to `0` or `false` to request that Appium not use the `unzip` binary included on your system for unzipping downloaded apps or other artifacts. Instead it will use a JS-based unzip library. This could help on some systems with non-existent or non-standard `unzip` commands. Note that if unzipping fails using the system library, the fallback library will be attempted in any case, so setting this env var merely saves time in the event you know the system unzip will fail. |
|
||||
| `APPIUM_HOST` | Same as the `--address` CLI arg |
|
||||
| `APPIUM_PORT` | Same as the `--port` CLI arg |
|
||||
| `APPIUM_RELOAD_EXTENSIONS` | Set to `1` to cause Appium to re-require extensions when new sessions are created. This is mostly useful for [building extensions](../developing/build-drivers.md) |
|
||||
| `APPIUM_OMIT_PEER_DEPS` | Adds `--omit=peer` to all the NPM commands run internally by Appium. Mostly an internal feature. |
|
||||
| `APPIUM_APPS_CACHE_MAX_AGE` | Allows to set the maximum age (in minutes) for [cached applications](../guides/caching.md). The default value is `60 * 24` (24 hours). Do not set it to a lower number than the duration of a single session startup. |
|
||||
| `APPIUM_APPS_CACHE_MAX_ITEMS` | Allows to set the maximum amount of [cached applications](../guides/caching.md). The default value is `1024`. Do not set it to a lower number than the amount of apps in all parallel sessions per process. |
|
||||
| `APPIUM_APPS_CACHE_IGNORE_URL_QUERY` | If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys. See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713) for more details. Disabled by default. |
|
||||
| Variable | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `APPIUM_HOME` | By default, Appium creates a directory called `.appium` in the home directory for your system user. You can adjust the directory with this variable, as detailed in the [Managing Extensions](../../guides/managing-exts.md) guide. |
|
||||
| `APPIUM_TMP_DIR` | By default, Appium uses a random temporary directory for many of its operations. If you wish to use a specific directory, you may do so by including an absolute path as the value of this variable. The behaviour is equivalent to using the `--tmp` CLI arg. |
|
||||
| `APPIUM_PREFER_SYSTEM_UNZIP` | Set to `0` or `false` to request that Appium not use the `unzip` binary included on your system for unzipping downloaded apps or other artifacts. Instead it will use a JS-based unzip library. This could help on some systems with non-existent or non-standard `unzip` commands. Note that if unzipping fails using the system library, the fallback library will be attempted in any case, so setting this env var merely saves time in the event you know the system unzip will fail. |
|
||||
| `APPIUM_HOST` | Same as the `--address` CLI arg |
|
||||
| `APPIUM_PORT` | Same as the `--port` CLI arg |
|
||||
| `APPIUM_RELOAD_EXTENSIONS` | Set to `1` to cause Appium to re-require extensions when new sessions are created. This is mostly useful for [building extensions](../../developing/build-drivers.md) |
|
||||
| `APPIUM_OMIT_PEER_DEPS` | Adds `--omit=peer` to all the NPM commands run internally by Appium. Mostly an internal feature. |
|
||||
| `APPIUM_APPS_CACHE_MAX_AGE` | Allows to set the maximum age (in minutes) for [cached applications](../../guides/caching.md). The default value is `60 * 24` (24 hours). Do not set it to a lower number than the duration of a single session startup. |
|
||||
| `APPIUM_APPS_CACHE_MAX_ITEMS` | Allows to set the maximum amount of [cached applications](../../guides/caching.md). The default value is `1024`. Do not set it to a lower number than the amount of apps in all parallel sessions per process. |
|
||||
| `APPIUM_APPS_CACHE_IGNORE_URL_QUERY` | If the above option is enabled then the 'search' part of the app URL will be cut off from cache keys. See the corresponding [feature request](https://discuss.appium.io/t/regarding-app-caching-when-using-aws-s3-presigned-urls/42713) for more details. Disabled by default. |
|
||||
@@ -5,16 +5,14 @@ title: Extension Command-Line Usage
|
||||
Appium allows for the flexible installation and management of various _extensions_, such as _drivers_
|
||||
(which provide Appium with the capability to automate a given platform) and _plugins_ (which can
|
||||
augment or alter the way individual Appium commands work). For a conceptual understanding of these
|
||||
entities, please review the [Introduction](../intro/index.md).
|
||||
entities, please review the [Introduction](../../intro/index.md).
|
||||
|
||||
Management of drivers and plugins is handled by Appium's Extension CLI (command-line interface).
|
||||
|
||||
!!! note
|
||||
|
||||
```
|
||||
This reference uses placeholders to refer to various options. Anywhere you see one of these
|
||||
placeholders in the reference, ensure you replace it with the correct type of actual content.
|
||||
```
|
||||
This reference uses placeholders to refer to various options. Anywhere you see one of these
|
||||
placeholders in the reference, ensure you replace it with the correct type of actual content.
|
||||
|
||||
| Placeholder | Meaning |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
@@ -36,7 +34,7 @@ and tuned for human consumption.
|
||||
|
||||
Run doctor checks for the given extension, which validate whether the extension has its prerequisites
|
||||
configured correctly. Note that not all extensions include doctor checks. See the
|
||||
[Building Doctor Checks](../developing/build-doctor-checks.md) tutorial for more details on
|
||||
[Building Doctor Checks](../../developing/build-doctor-checks.md) tutorial for more details on
|
||||
how to create them.
|
||||
|
||||
Usage:
|
||||
@@ -110,27 +108,27 @@ by `npm install`:
|
||||
|
||||
- Install the latest XCUITest driver:
|
||||
|
||||
```
|
||||
appium driver install xcuitest
|
||||
```
|
||||
```
|
||||
appium driver install xcuitest
|
||||
```
|
||||
|
||||
- Install the XCUITest driver at version 4.11.1:
|
||||
|
||||
```
|
||||
appium driver install xcuitest@4.11.1
|
||||
```
|
||||
```
|
||||
appium driver install xcuitest@4.11.1
|
||||
```
|
||||
|
||||
- Install the `beta` version of the `@appium/fake-driver` from NPM:
|
||||
|
||||
```
|
||||
appium driver install --source=npm @appium/fake-driver@beta
|
||||
```
|
||||
```
|
||||
appium driver install --source=npm @appium/fake-driver@beta
|
||||
```
|
||||
|
||||
- Install a locally-developed plugin:
|
||||
|
||||
```
|
||||
appium plugin install --source=local /path/to/my/plugin
|
||||
```
|
||||
```
|
||||
appium plugin install --source=local /path/to/my/plugin
|
||||
```
|
||||
|
||||
### `list`
|
||||
|
||||
@@ -5,8 +5,8 @@ hide:
|
||||
title: Command Line Interface
|
||||
---
|
||||
|
||||
Appium provides a command-line executable (`appium`), which will likely be your main way of interacting with
|
||||
the Appium server. This section of the Appium documentation describes how to use this executable.
|
||||
Appium provides a command-line executable (`appium`), which can be used to configure and launch
|
||||
the Appium server, as well as manage drivers and plugins.
|
||||
|
||||
To start off, you can run `appium -v` or `appium --version` to return the installed version,
|
||||
or run `appium -h` or `appium --help` to return the help message.
|
||||
@@ -23,4 +23,5 @@ The main `appium` executable provides the following subcommands:
|
||||
4. `appium setup` - batch install a preset of drivers and plugins
|
||||
- [See here for details](./setup.md)
|
||||
|
||||
Like the main command, you can also run each subcommand with the `-h` or `--help` flag to learn more about it.
|
||||
Like the main command, you can also run each subcommand with the `-h` or `--help` flag to learn
|
||||
more about it.
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Setup Command-Line Usage
|
||||
---
|
||||
|
||||
@@ -20,7 +21,7 @@ The presets are as follows:
|
||||
Attempting to install a preset while already having one or more of its included extensions installed
|
||||
will only install the missing extensions.
|
||||
|
||||
Refer to the [Ecosystem documentation](../ecosystem/index.md) to learn more about the extensions
|
||||
Refer to the [Ecosystem documentation](../../ecosystem/index.md) to learn more about the extensions
|
||||
listed above.
|
||||
|
||||
This commands also supports the functionality that allows to fully reset your Appium server
|
||||
25
packages/appium/docs/zh/reference/index.md
Normal file
25
packages/appium/docs/zh/reference/index.md
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
hide:
|
||||
- toc
|
||||
|
||||
title: Reference
|
||||
---
|
||||
|
||||
This section of the Appium documentation provides a reference to the two main interfaces within the
|
||||
Appium server: the command-line executable, and the supported API endpoints.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :octicons-command-palette-16: [**Command Line Interface**](./cli/index.md)
|
||||
|
||||
---
|
||||
|
||||
Learn how to use the Appium command-line executable
|
||||
|
||||
- :material-cloud-braces: [**API Endpoints**](./api/index.md)
|
||||
|
||||
---
|
||||
|
||||
View endpoints supported by the Appium server
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user