拡張機能のコマンドラインの使い方
Appiumは、*ドライバー*（特定のプラットフォームを自動化する機能をAppiumに提供する）や*プラグイン*（個々のAppiumコマンドの動作方法を拡張または変更できる）など、さまざまな*拡張機能*の柔軟なインストールと管理を可能にします。 これらのエンティティの概念的な理解については、はじめにをご覧ください。
ドライバーとプラグインの管理は、Appiumの拡張機能CLI（コマンドラインインターフェース）によって処理されます。
注意
このリファレンスでは、プレースホルダーを使用してさまざまなオプションを参照しています。 リファレンスにこれらのプレースホルダーが表示された場合は、必ず正しいタイプの実際のコンテンツに置き換えてください。
| プレースホルダー | 意味 |
|---|---|
<ext-type> |
「拡張機能の種類」。 driverまたはpluginのいずれかである必要があります。 すべての拡張機能CLIコマンドは、ドライバーまたはプラグインのいずれかと共に使用できるため、どちらの種類の拡張機能を使用するかを指定する必要があります |
<ext-name> |
「拡張機能名」。 これは、appium <ext-type> listの呼び出しで見つかった拡張機能の短い名前です。 これは、拡張機能のNPMパッケージ名、または一般的には拡張機能の「インストール仕様」とは異なります。 |
<install-spec> |
「インストール仕様」。 これは、Appiumがどの拡張機能をインストールする必要があるかを示すために使用される文字列を指します。 |
<install-source> |
これは、Appiumが拡張機能をインストールするために使用する必要がある方法を指します。 |
コマンド¶
すべての拡張機能CLIコマンドは、appium <ext-type>、つまりappium driverまたはappium pluginで始まります。
すべての拡張機能CLIコマンドは、オプションの--json引数を取ることができます。 これにより、コマンドの結果が、人間が消費しやすいように色付けされ調整された標準出力ではなく、機械で読み取り可能なJSON文字列として返されます。
list¶
インストール済みおよび利用可能な拡張機能を一覧表示します。 「利用可能」な拡張機能には、Appiumチームによって公式に認識されているものが含まれますが、このリストに表示されている拡張機能のみをインストールする必要はありません。
使い方
必須の引数
<ext-type>:driverまたはpluginである必要があります
オプションの引数
--installed: インストール済みの拡張機能のみを表示し、利用可能な拡張機能は表示しません--updates: NPM経由でインストールされた拡張機能の場合、更新がある場合はメッセージを表示します--json: 結果をJSON形式で返します
install¶
拡張機能をインストールします。 成功した場合、拡張機能CLIの他の呼び出しで使用できる拡張機能の短い名前で応答します。 拡張機能がドライバーの場合は、ドライバーで使用できるプラットフォームにも注意してください。
使い方
appium <ext-type> install <install-spec> [--source=<install-source>] [--package=<package-name>] [--json]
必須の引数
<ext-type>:driverまたはpluginである必要があります- 必須の引数
オプションの引数
<install-spec>: これは、インストールする拡張機能の名前、場所、および/またはバージョンです。 使用可能な値は、<install-source>に依存します（以下を参照）。- オプションの引数
--json: 結果をJSON形式で返します
--source: これは、Appiumに拡張機能の場所を指示します。 使用可能なソースの種類と対応するインストール仕様の表については、以下を参照してください。 |
--package: <install-source>がgitまたはgithubの場合、--packageが必要です。 拡張機能のNode.jsパッケージ名である必要があります。 この情報がないと、Appiumはインストールされたパッケージを見つけることができません。 |
|---|---|
| インストールソースの種類 | 動作 |
なし |
これは、--sourceが使用されていない場合のデフォルトの動作です。 この場合、Appiumは<install-spec>を見て、appium <ext-type> listを実行したときに利用可能な拡張機能の名前、つまり公式に認識されている拡張機能名と照合します。 見つかった場合、NPM経由でその拡張機能を最新バージョンでインストールします |
npm |
NPMパッケージ名に基づいて拡張機能をインストールします。 ここで、<install-spec>は、バージョンなどの追加のNPMインストール修飾子を含むNPMパッケージ名である必要があります（以下を参照）。 |
github |
<org>/<repo>形式のGitHub仕様を介して拡張機能をインストールします |
git |
Git URL（例：git+ssh://git-host.com/repo.git）を介して拡張機能をインストールします |
local
ローカルパスを介して拡張機能をインストールします。 これは、ドライバーのNode.jsパッケージ情報が locatedるディレクトリへのパスである必要があります。
NPMベースの<install-spec>¶AppiumがNPM経由で拡張機能をインストールする場合（--sourceが省略されているかnpmに設定されている場合）、<install-spec>は複雑になる可能性があり、npm installで許可されているあらゆる種類の情報を含めることができますサポートされているNPMインストール仕様[@scope]/<name>
[@scope]/<name>@<version>
-
[@scope]/<name>@<tag>
-
[@scope]/<name>@<version range>
appium driver install [email protected] -
例¶
-
最新のXCUITestドライバーをインストールする
`appium driver install xcuitest`
XCUITestドライバーをバージョン4.11.1にインストールする
使い方
必須の引数
<ext-type>:driverまたはpluginである必要があります- `appium driver install xcuitest@4.11.1`
オプションの引数
- NPMから
@appium/fake-driverのbetaバージョンをインストールする --json: 結果をJSON形式で返します
`appium driver install @appium/fake-driver@beta`
ローカルで開発されたプラグインをインストールする
使い方
必須の引数
<ext-type>:driverまたはpluginである必要があります- `appium plugin install --source=local /path/to/plugin`
オプションの引数
--json: 結果をJSON形式で返します
update¶
NPM経由でインストールされた1つ以上の拡張機能を更新します。 デフォルトでは、Appiumはメジャーバージョンにリビジョンがある拡張機能を自動的に更新しません。これは、意図しない破壊的な変更を防ぐためです。
使い方
必須の引数
<ext-type>:driverまたはpluginである必要があります- 必須の引数
<ext-name>: 更新する拡張機能の名前、または文字列installed（インストールされているすべての拡張機能を更新します）
オプションの引数
- オプションの引数
--json: 結果をJSON形式で返します
--unsafe: メジャーバージョンの境界を超えて更新するようにAppiumに指示します
uninstall¶
インストールされている拡張機能を削除します。
使い方
必須の引数