CLI Reference

XServer CLI リファレンス — XServer for WordPress管理

XServer CLI から XServer for WordPress の利用上限・使用量、サイト、WordPress運用、ドメイン・DNS、PHP、ログ、Cron、SSH、バックアップなどを管理できます。

xserver wphosting 配下のコマンドを掲載しています。XServer for WordPress 専用の機能です。

CLIの変更履歴は 更新履歴 を参照してください。

インストール

Node.js(v18 以上)がインストールされた環境で、npm からグローバルインストールしてください。

インストール
npm install -g xserver-cli

インストールせずに即時実行することもできます。

npx でサイト一覧を取得
npx xserver-cli wphosting --contract-id WP-AB234567 sites list

バージョン確認

バージョン確認
xserver --version

認証設定

認証に使用する秘密値はAPIキーのみです。XServerアカウントの「APIキー管理」で、対象のご契約・サイトと必要な権限を設定して発行してください。XServer for WordPressの操作対象はコマンドで指定します。

xserver auth login

対話形式でAPIキーを設定します。入力したAPIキーはマスク表示され、ログイン時に利用可能なサービス・権限・対象契約・対象サイト・APIキー有効期限を表示してから、名前付きプロファイルに保存します。

対話形式でログイン
xserver auth login
# ✔ APIキーを入力: ****
# 認証情報を検証中...
# ✓ 認証に成功しました
#
# 利用可能なサービス:
#   XServer for WordPress
#     権限: すべての操作
#     対象契約:
#       - WP-AB234567
#     対象サイト:
#       - xw123456.xwp.jp
#
# APIキー有効期限: 2026-12-31 00:00:00
#
# ✓ プロファイル "default" を保存しました
#   設定ファイル: ~/.config/xserver-cli/config.json

--api-keyによる非対話設定もできますが、値がプロセス一覧やシェル履歴へ残る可能性があります。CI/CDでは実行環境のシークレット機能を使用してください。

プロファイル

複数のAPIキーは名前付きプロファイルとして保存し、実行時に切り替えられます。

プロファイルを指定して実行
xserver --profile staging wphosting --contract-id WP-AB234567 sites list

設定ファイルは ~/.config/xserver-cli/config.json に保存されます。

環境変数

CI/CDでは環境変数でAPIキーを指定できます。サイト識別子(--servername)は環境変数に固定せず、コマンドで指定します。

環境変数説明
XSERVER_API_KEYAPIキー
事前設定した環境変数で認証
# XSERVER_API_KEYは実行環境のシークレット機能などで事前に設定
xserver wphosting --contract-id WP-AB234567 sites list

操作対象の指定

wphosting のすべてのコマンドで、--contract-id <id>WP- で始まる64文字以内の契約IDを指定します。

サイトを対象とするコマンドでは、サイト一覧で取得したサイト環境の識別子(*.xwp.jp)を --servername <name> に指定します。例外は、対象サイトをまだ持たない sites listsites createusage show です。通常は staging --servername ... create のようにサブコマンドの直後へ置き、sites showsites delete では show または delete の直後へ置きます。

サイトを指定して情報を取得
xserver wphosting --contract-id WP-AB234567 sites show --servername xw123456.xwp.jp

ここでのドメイン・DNS操作はXServer for WordPressのサイトに紐づく設定が対象です。ドメインレジストラで保有するドメインの管理には xserver domain を使用してください。

グローバルオプション

オプション説明デフォルト
--format <format>出力形式(table または jsontable
--profile <name>使用するプロファイル名default
-y, --yes破壊的操作の確認プロンプトを承認して実行
--debugトラブルシューティング情報を標準エラー出力へ表示
-V, --versionバージョン番号を表示
-h, --helpヘルプを表示

wphosting 親オプション

オプション必須説明
--contract-id <id>必須対象のXServer for WordPress契約ID(WP-で始まる英数字、64文字以内)
--servername <name>コマンドによるサイト一覧で取得したサイト環境の識別子(*.xwp.jp

出力形式

既定では人が読みやすいテーブル形式で出力します。自動処理では --format json を使用できます。

確認が必要な操作では、対象のプレビューや確認メッセージを標準エラー出力へ、最終結果を標準出力へ表示します。--format json の標準出力はそのままパイプ処理できます。

テーブル形式
xserver wphosting --contract-id WP-AB234567 sites list
JSON形式
xserver --format json wphosting --contract-id WP-AB234567 sites list
jq と組み合わせ
xserver --format json wphosting --contract-id WP-AB234567 sites list | jq ".sites[].servername"

非同期処理

次の5操作はバックグラウンドで実行されます。一定時間おいてから、下表のコマンドで状態を確認してください。

操作確認先
サイト作成sites show で確認。setting(設定中)から public/private(利用可能)になれば完了、error は失敗
サイト削除sites list から対象が除外されれば削除受付済み
ステージング環境作成作成先のサイト識別子を指定した sites show で確認
手動バックアップ作成backups list で確認。completed は完了、failed は失敗。waiting/running などは処理中
バックアップ復元backups restore-history で確認。completed は完了、failed は失敗。中間状態では待機して再確認

冪等性キー(--idempotency-key

5つの非同期操作では --idempotency-key <key> を任意指定でき、省略時はCLIが自動生成して表示します。通信エラーなどで結果が不明な場合は、最初に表示された同じキーと同じ内容で再実行すると重複実行を防げます。キーには8〜64文字の英数字・ハイフン・アンダースコアを使用できます。

破壊的操作の安全確認

サイト削除やバックアップ復元など、元に戻せない、または既存データを上書きする操作では、CLIが契約ID・サイト識別子・処理内容などの対象を表示して確認します。既定の回答は No です。

自動実行で確認を省略する場合のみ --yes を指定してください。

  • 本番サイトを削除すると、関連するステージング環境も削除されます。削除したデータは復元できません。
  • バックアップ復元は現在のサイトデータを上書きします。対象サイトとバックアップを確認してから実行してください。

秘密値の取り扱い

  • パスワードやパスフレーズをコマンドへ直接指定すると、プロセス一覧やシェル履歴へ残る可能性があります。共有端末での実行を避け、履歴・CIログ・実行権限を適切に管理してください。
  • --debugの出力には機密情報が含まれる場合があります。共有前に必ず内容を確認してください。
  • SSH鍵を自動生成した場合、秘密鍵は生成時に一度だけ表示されます。直ちに安全な場所へ保存し、ログへ残さないでください。

サイト

サイト一覧を取得 xserver wphosting --contract-id <id> sites list

契約に属するXServer for WordPressのサイト一覧を取得します。--servernameは不要です。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)

使用例

サイト一覧を取得
xserver wphosting --contract-id WP-AB234567 sites list
サイト詳細を取得 xserver wphosting --contract-id <id> sites show --servername <site>

指定サイトの詳細を取得します。--servername は show の直後に指定します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

サイト詳細を取得
xserver wphosting --contract-id WP-AB234567 sites show --servername xw123456.xwp.jp
サイトを作成 xserver wphosting --contract-id <id> sites create --wp-sitename <name> --wp-username <name> --wp-password <password> --wp-mailaddress <email> --disk-limit-gb <gb> --vcpu-limit <n> --memory-limit-gb <gb> [options]

サイトはバックグラウンドで作成されます。返却されたサイト識別子を使い「xserver wphosting --contract-id <id> sites show --servername <site>」で状態を確認します。--servernameは作成前には不要です。パスワードはコマンド履歴やログへ残さず、安全な入力・保管方法を使用してください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--wp-sitename <name>必須WordPressサイト名(1~255文字)
--wp-username <name>必須管理ユーザー名(1~255文字。英数字・空白・_・-・.・@)
--wp-password <password>必須7~64文字。半角英字と数字または許可記号を含め、ユーザー名と同一不可(秘密値)
--wp-mailaddress <email>必須管理メールアドレス(メール形式、100文字以内)
--disk-limit-gb <gb>必須10以上の整数
--vcpu-limit <n>必須1以上の整数
--memory-limit-gb <gb>必須1以上の整数
--wp-theme <theme>任意default / cocoon-master / lightning
--server-id <id>任意小文字英字で始まる12文字以内の小文字英数字
--security-auto-optimize <bool>任意true / false
--memo <memo>任意1~255文字
--idempotency-key <key>任意英数字・_・-の8~64文字(省略時は自動生成)

使用例

サイトを作成
xserver wphosting --contract-id WP-AB234567 sites create --wp-sitename "Example" --wp-username admin --wp-password "<secret>" --wp-mailaddress admin@example.com --disk-limit-gb 10 --vcpu-limit 1 --memory-limit-gb 1
サイトを削除 xserver wphosting --contract-id <id> sites delete --servername <site> [options]

サイト詳細を確認対象として表示し、既定では No(いいえ)の確認後に削除します。--yesで確認を省略できます。本番サイトの削除に連動してステージングも削除され、元に戻せません。削除はバックグラウンドで処理されます。「xserver wphosting --contract-id <id> sites list」で一覧から除外されたことを確認します。--servername は delete の直後に指定します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--idempotency-key <key>任意英数字・_・-の8~64文字(省略時は自動生成)
-y, --yes任意確認プロンプトをスキップ

使用例

サイトを確認して削除
xserver wphosting --contract-id WP-AB234567 sites delete --servername xw123456.xwp.jp
確認をスキップ
xserver wphosting --contract-id WP-AB234567 sites delete --servername xw123456.xwp.jp -y

使用量

契約上限とサイト別使用量を取得 xserver wphosting --contract-id <id> usage show

契約全体の上限とサイト別使用量を取得します。servernameは不要です。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)

使用例

利用状況を取得
xserver wphosting --contract-id WP-AB234567 usage show

ステージング

ステージング環境を作成 xserver wphosting --contract-id <id> staging --servername <site> create --disk-limit-gb <gb> --vcpu-limit <n> --memory-limit-gb <gb> [options]

指定した本番サイトのステージング環境をバックグラウンドで作成します。返却されたサイト識別子を使い「xserver wphosting --contract-id <id> sites show --servername <site>」で状態を確認します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--disk-limit-gb <gb>必須10以上の整数
--vcpu-limit <n>必須1以上の整数
--memory-limit-gb <gb>必須1以上の整数
--server-id <id>任意小文字英字で始まる12文字以内の小文字英数字
--security-auto-optimize <bool>任意true / false
--idempotency-key <key>任意英数字・_・-の8~64文字(省略時は自動生成)

使用例

ステージングを作成
xserver wphosting --contract-id WP-AB234567 staging --servername xw123456.xwp.jp create --disk-limit-gb 10 --vcpu-limit 1 --memory-limit-gb 1

手動バックアップ

バックアップ一覧を取得 xserver wphosting --contract-id <id> backups --servername <site> list

指定サイトの手動バックアップ一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

一覧を取得
xserver wphosting --contract-id WP-AB234567 backups --servername xw123456.xwp.jp list
バックアップを作成 xserver wphosting --contract-id <id> backups --servername <site> create [--memo <memo>] [--idempotency-key <key>]

手動バックアップをバックグラウンドで作成します。「xserver wphosting --contract-id <id> backups --servername <site> list」で作成状況を確認します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--memo <memo>任意1~255文字
--idempotency-key <key>任意英数字・_・-の8~64文字(省略時は自動生成)

使用例

バックアップを作成
xserver wphosting --contract-id WP-AB234567 backups --servername xw123456.xwp.jp create --memo "before update"
バックアップを復元 xserver wphosting --contract-id <id> backups --servername <site> restore --backup-id <id> [options]

一覧から復元対象を表示し、既定では No(いいえ)の確認後に現在のサイト内容を上書きします。取り消せません。--yesで確認を省略できます。復元はバックグラウンドで処理されます。「xserver wphosting --contract-id <id> backups --servername <site> restore-history」で状態を確認します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--backup-id <id>必須英数字・_・-の1~255文字
--idempotency-key <key>任意英数字・_・-の8~64文字(省略時は自動生成)
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して復元
xserver wphosting --contract-id WP-AB234567 backups --servername xw123456.xwp.jp restore --backup-id BACKUP_123
確認をスキップ
xserver wphosting --contract-id WP-AB234567 backups --servername xw123456.xwp.jp restore --backup-id BACKUP_123 -y
復元履歴を取得 xserver wphosting --contract-id <id> backups --servername <site> restore-history

指定サイトのバックアップ復元履歴を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

復元履歴を取得
xserver wphosting --contract-id WP-AB234567 backups --servername xw123456.xwp.jp restore-history
バックアップを削除 xserver wphosting --contract-id <id> backups --servername <site> delete --backup-id <id> [options]

一覧から削除対象を表示し、既定では No(いいえ)の確認後に削除します。削除後は復元できません。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--backup-id <id>必須英数字・_・-の1~255文字
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 backups --servername xw123456.xwp.jp delete --backup-id BACKUP_123
確認をスキップ
xserver wphosting --contract-id WP-AB234567 backups --servername xw123456.xwp.jp delete --backup-id BACKUP_123 -y

WordPress本体

WordPress情報を取得 xserver wphosting --contract-id <id> wordpress --servername <site> show

WordPress本体の情報と更新状態を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

情報を取得
xserver wphosting --contract-id WP-AB234567 wordpress --servername xw123456.xwp.jp show
自動更新設定を変更 xserver wphosting --contract-id <id> wordpress --servername <site> update --auto-update-scope <scope>

WordPress本体の自動更新範囲を変更します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--auto-update-scope <scope>必須none / minor / all

使用例

マイナー更新を有効化
xserver wphosting --contract-id WP-AB234567 wordpress --servername xw123456.xwp.jp update --auto-update-scope minor
WordPress本体を更新 xserver wphosting --contract-id <id> wordpress --servername <site> upgrade

WordPress本体のバージョン更新を実行します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

本体を更新
xserver wphosting --contract-id WP-AB234567 wordpress --servername xw123456.xwp.jp upgrade

メンテナンスモード

設定を取得 xserver wphosting --contract-id <id> maintenance-mode --servername <site> show

メンテナンスモードの設定を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

設定を取得
xserver wphosting --contract-id WP-AB234567 maintenance-mode --servername xw123456.xwp.jp show
設定を変更 xserver wphosting --contract-id <id> maintenance-mode --servername <site> update --enabled <bool>

メンテナンスモードを有効または無効にします。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--enabled <bool>必須true / false

使用例

有効化
xserver wphosting --contract-id WP-AB234567 maintenance-mode --servername xw123456.xwp.jp update --enabled true

プラグイン

プラグイン一覧を取得 xserver wphosting --contract-id <id> plugins --servername <site> list

インストール済みプラグイン一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

一覧を取得
xserver wphosting --contract-id WP-AB234567 plugins --servername xw123456.xwp.jp list
プラグインをインストール xserver wphosting --contract-id <id> plugins --servername <site> install --plugin <slug> [--activate <bool>]

公式リポジトリからslugを指定してインストールします。--activateの省略時はfalseです。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--plugin <slug>必須公式リポジトリのプラグインslug
--activate <bool>任意true / false(既定false)

使用例

インストールして有効化
xserver wphosting --contract-id WP-AB234567 plugins --servername xw123456.xwp.jp install --plugin akismet --activate true
プラグイン設定を部分更新 xserver wphosting --contract-id <id> plugins --servername <site> update --plugin <slug> [--status <status>] [--auto-update <bool>]

--status または --auto-update で指定した設定を変更します。少なくとも1項目を指定してください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--plugin <slug>必須対象プラグインslug
--status <status>任意active / inactive
--auto-update <bool>任意true / false

使用例

自動更新を有効化
xserver wphosting --contract-id WP-AB234567 plugins --servername xw123456.xwp.jp update --plugin akismet --auto-update true
プラグインを更新 xserver wphosting --contract-id <id> plugins --servername <site> upgrade --plugin <slug>

指定プラグインのバージョン更新を実行します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--plugin <slug>必須対象プラグインslug

使用例

更新を実行
xserver wphosting --contract-id WP-AB234567 plugins --servername xw123456.xwp.jp upgrade --plugin akismet
プラグインを削除 xserver wphosting --contract-id <id> plugins --servername <site> delete --plugin <slug> [options]

一覧から対象プラグインを表示し、既定では No(いいえ)の確認後に削除します。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--plugin <slug>必須対象プラグインslug
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 plugins --servername xw123456.xwp.jp delete --plugin akismet
確認をスキップ
xserver wphosting --contract-id WP-AB234567 plugins --servername xw123456.xwp.jp delete --plugin akismet -y

テーマ

テーマ一覧を取得 xserver wphosting --contract-id <id> themes --servername <site> list

インストール済みテーマ一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

一覧を取得
xserver wphosting --contract-id WP-AB234567 themes --servername xw123456.xwp.jp list
テーマをインストール xserver wphosting --contract-id <id> themes --servername <site> install --theme <slug> [--activate <bool>]

公式リポジトリからslugを指定してインストールします。--activateの省略時はfalseです。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--theme <slug>必須公式リポジトリのテーマslug
--activate <bool>任意true / false(既定false)

使用例

インストールして有効化
xserver wphosting --contract-id WP-AB234567 themes --servername xw123456.xwp.jp install --theme twentytwentyfour --activate true
テーマ設定を部分更新 xserver wphosting --contract-id <id> themes --servername <site> update --theme <slug> [--status active] [--auto-update <bool>]

--status または --auto-update で指定した設定を変更します。少なくとも1項目を指定してください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--theme <slug>必須対象テーマslug
--status <status>任意activeのみ
--auto-update <bool>任意true / false

使用例

テーマを有効化
xserver wphosting --contract-id WP-AB234567 themes --servername xw123456.xwp.jp update --theme twentytwentyfour --status active
テーマを更新 xserver wphosting --contract-id <id> themes --servername <site> upgrade --theme <slug>

指定テーマのバージョン更新を実行します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--theme <slug>必須対象テーマslug

使用例

更新を実行
xserver wphosting --contract-id WP-AB234567 themes --servername xw123456.xwp.jp upgrade --theme twentytwentyfour
テーマを削除 xserver wphosting --contract-id <id> themes --servername <site> delete --theme <slug> [options]

一覧から対象テーマを表示し、既定では No(いいえ)の確認後に削除します。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--theme <slug>必須対象テーマslug
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 themes --servername xw123456.xwp.jp delete --theme twentytwentyfour
確認をスキップ
xserver wphosting --contract-id WP-AB234567 themes --servername xw123456.xwp.jp delete --theme twentytwentyfour -y

ドメイン

ドメイン一覧を取得 xserver wphosting --contract-id <id> domains --servername <site> list

サイトに設定されたドメイン一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

一覧を取得
xserver wphosting --contract-id WP-AB234567 domains --servername xw123456.xwp.jp list
ドメインを追加 xserver wphosting --contract-id <id> domains --servername <site> add --domain <domain>

サイトへドメインを追加します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須追加するドメイン名

使用例

ドメインを追加
xserver wphosting --contract-id WP-AB234567 domains --servername xw123456.xwp.jp add --domain example.com
ドメイン所有者確認を実行 xserver wphosting --contract-id <id> domains --servername <site> verify --domain <domain>

指定ドメインの所有者確認を実行します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須確認するドメイン名

使用例

所有者確認を実行
xserver wphosting --contract-id WP-AB234567 domains --servername xw123456.xwp.jp verify --domain example.com
ドメイン設定を削除 xserver wphosting --contract-id <id> domains --servername <site> delete --domain <domain> [options]

一覧から対象ドメインを表示し、既定では No(いいえ)の確認後に設定を削除します。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須削除するドメイン名
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 domains --servername xw123456.xwp.jp delete --domain example.com
確認をスキップ
xserver wphosting --contract-id WP-AB234567 domains --servername xw123456.xwp.jp delete --domain example.com -y

サイトURL

サイトURLを変更 xserver wphosting --contract-id <id> site-url --servername <site> update --domain <domain> [--auto-redirect <bool>]

プライマリドメインを変更します。--auto-redirectは旧URLから新URLへの転送で、省略時trueです。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須変更先ドメイン
--auto-redirect <bool>任意true / false(既定true)

使用例

サイトURLを変更
xserver wphosting --contract-id WP-AB234567 site-url --servername xw123456.xwp.jp update --domain example.com

DNS

DNSレコード一覧を取得 xserver wphosting --contract-id <id> dns --servername <site> list --domain <domain>

指定ドメインのDNSレコード一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須対象ドメイン

使用例

一覧を取得
xserver wphosting --contract-id WP-AB234567 dns --servername xw123456.xwp.jp list --domain example.com
DNSレコードを追加 xserver wphosting --contract-id <id> dns --servername <site> add --domain <domain> --host <host> --type <type> --content <content> [options]

DNSレコードを追加します。レコードタイプは大文字・小文字を区別しません。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須対象ドメイン
--host <host>必須ホスト名(ルートドメインは @)
--type <type>必須A / AAAA / CNAME / MX / TXT / SRV
--content <content>必須レコード値
--ttl <seconds>任意60~86400の整数
--priority <n>任意0~65535の整数

使用例

Aレコードを追加
xserver wphosting --contract-id WP-AB234567 dns --servername xw123456.xwp.jp add --domain example.com --host www --type A --content 192.0.2.1
DNSレコードを部分更新 xserver wphosting --contract-id <id> dns --servername <site> update --domain <domain> --dns-id <id> [options]

指定DNSレコードの設定を変更します。--host、--type、--content、--ttl、--priorityのうち少なくとも1項目を指定してください。レコードタイプは大文字・小文字を区別しません。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須対象ドメイン
--dns-id <id>必須正の整数
--host <host>任意ホスト名(ルートドメインは @)
--type <type>任意A / AAAA / CNAME / MX / TXT / SRV
--content <content>任意レコード値
--ttl <seconds>任意60~86400の整数
--priority <n>任意0~65535の整数

使用例

レコード値を更新
xserver wphosting --contract-id WP-AB234567 dns --servername xw123456.xwp.jp update --domain example.com --dns-id 123 --content 192.0.2.2
DNSレコードを削除 xserver wphosting --contract-id <id> dns --servername <site> delete --domain <domain> --dns-id <id> [options]

一覧から対象レコードを表示し、既定では No(いいえ)の確認後に削除します。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--domain <domain>必須対象ドメイン
--dns-id <id>必須正の整数
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 dns --servername xw123456.xwp.jp delete --domain example.com --dns-id 123
確認をスキップ
xserver wphosting --contract-id WP-AB234567 dns --servername xw123456.xwp.jp delete --domain example.com --dns-id 123 -y

PHPバージョン

PHPバージョンを取得 xserver wphosting --contract-id <id> php-version --servername <site> show

現在値と利用可能なPHPバージョンを取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

バージョンを取得
xserver wphosting --contract-id WP-AB234567 php-version --servername xw123456.xwp.jp show
PHPバージョンを変更 xserver wphosting --contract-id <id> php-version --servername <site> update --php <version>

php-version showで表示される選択可能なバージョンへ変更します。値は8.3のような「数字.数字」形式です。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--php <version>必須php-version showで表示される選択可能なバージョン

使用例

PHP 8.3へ変更
xserver wphosting --contract-id WP-AB234567 php-version --servername xw123456.xwp.jp update --php 8.3

アクセスログ

アクセスログを取得 xserver wphosting --contract-id <id> access-log --servername <site> show [--date <date>] [--keyword <keyword>] [--line-number <n>]

日付・キーワード・行数で絞り込んでアクセスログを取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--date <date>任意実在するYYYY-MM-DD形式の日付
--keyword <keyword>任意絞り込みキーワード
--line-number <n>任意1~50000の整数

使用例

当日の末尾100行を取得
xserver wphosting --contract-id WP-AB234567 access-log --servername xw123456.xwp.jp show --date 2026-08-12 --line-number 100

エラーログ

エラーログを取得 xserver wphosting --contract-id <id> error-log --servername <site> show [--keyword <keyword>] [--line-number <n>]

キーワード・行数で絞り込んでエラーログを取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--keyword <keyword>任意絞り込みキーワード
--line-number <n>任意1~50000の整数

使用例

末尾100行を取得
xserver wphosting --contract-id WP-AB234567 error-log --servername xw123456.xwp.jp show --line-number 100

Cron

Cron一覧を取得 xserver wphosting --contract-id <id> cron --servername <site> list

サイトに登録されたCron一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

一覧を取得
xserver wphosting --contract-id WP-AB234567 cron --servername xw123456.xwp.jp list
Cronを追加 xserver wphosting --contract-id <id> cron --servername <site> add --minute <value> --hour <value> --day <value> --month <value> --weekday <value> --command <command> [--comment <comment>]

5つのスケジュール値と実行コマンドを指定してCronを追加します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--minute <value>必須
--hour <value>必須
--day <value>必須
--month <value>必須
--weekday <value>必須曜日
--command <command>必須実行コマンド
--comment <comment>任意コメント

使用例

毎時実行を追加
xserver wphosting --contract-id WP-AB234567 cron --servername xw123456.xwp.jp add --minute 0 --hour "*" --day "*" --month "*" --weekday "*" --command "php /path/task.php"
Cronを部分更新 xserver wphosting --contract-id <id> cron --servername <site> update --cron-id <id> [options]

指定Cronを部分更新します。minute、hour、day、month、weekday、command、comment、enabledのうち最低1項目を指定してください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--cron-id <id>必須英数字・_・-の1~255文字
--minute <value>任意
--hour <value>任意
--day <value>任意
--month <value>任意
--weekday <value>任意曜日
--command <command>任意実行コマンド
--comment <comment>任意コメント
--enabled <bool>任意true / false

使用例

Cronを無効化
xserver wphosting --contract-id WP-AB234567 cron --servername xw123456.xwp.jp update --cron-id CRON_123 --enabled false
Cronを削除 xserver wphosting --contract-id <id> cron --servername <site> delete --cron-id <id> [options]

一覧から対象Cronを表示し、既定では No(いいえ)の確認後に削除します。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--cron-id <id>必須英数字・_・-の1~255文字
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 cron --servername xw123456.xwp.jp delete --cron-id CRON_123
確認をスキップ
xserver wphosting --contract-id WP-AB234567 cron --servername xw123456.xwp.jp delete --cron-id CRON_123 -y

SSH

SSH設定を取得 xserver wphosting --contract-id <id> ssh --servername <site> show

SSHと国外アクセス制限の設定を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

設定を取得
xserver wphosting --contract-id WP-AB234567 ssh --servername xw123456.xwp.jp show
SSH設定を部分更新 xserver wphosting --contract-id <id> ssh --servername <site> update [--ssh-enabled <bool>] [--abroad-access-restriction <bool>]

SSH有効状態と国外アクセス制限を部分更新します。2項目のうち最低1項目を指定してください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--ssh-enabled <bool>任意true / false
--abroad-access-restriction <bool>任意true / false

使用例

SSHを有効化
xserver wphosting --contract-id WP-AB234567 ssh --servername xw123456.xwp.jp update --ssh-enabled true
SSH公開鍵一覧を取得 xserver wphosting --contract-id <id> ssh --servername <site> keys list

登録済みSSH公開鍵一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

公開鍵一覧を取得
xserver wphosting --contract-id WP-AB234567 ssh --servername xw123456.xwp.jp keys list
SSH公開鍵を登録または生成 xserver wphosting --contract-id <id> ssh --servername <site> keys add --label <label> [--public-key <key> | --generate true [--passphrase <passphrase>]]

公開鍵を登録するか鍵ペアを生成します。--public-keyまたは--generate trueが必要で、同時指定できません。--passphraseは生成時だけ指定できます。生成された秘密鍵は一度だけ表示されるため、直ちに安全な場所へ保存してください。公開鍵・パスフレーズ・秘密鍵をコマンド履歴やログへ残さないでください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--label <label>必須1~500文字
--public-key <key>任意登録する公開鍵(--generate trueと排他)
--generate <bool>任意true / false(省略時false)
--passphrase <passphrase>任意生成時のみ。6~32文字の秘密値

使用例

鍵ペアを生成
xserver wphosting --contract-id WP-AB234567 ssh --servername xw123456.xwp.jp keys add --label deploy --generate true --passphrase "<secret>"
SSH公開鍵を部分更新 xserver wphosting --contract-id <id> ssh --servername <site> keys update --key-id <id> [--label <label>] [--status <status>]

公開鍵のラベルまたは状態を部分更新します。--label と --status のうち最低1項目を指定してください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--key-id <id>必須正の整数
--label <label>任意1~500文字
--status <status>任意on / off

使用例

鍵を無効化
xserver wphosting --contract-id WP-AB234567 ssh --servername xw123456.xwp.jp keys update --key-id 123 --status off
SSH公開鍵を削除 xserver wphosting --contract-id <id> ssh --servername <site> keys delete --key-id <id> [options]

一覧から対象公開鍵を表示し、既定では No(いいえ)の確認後に削除します。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--key-id <id>必須正の整数
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 ssh --servername xw123456.xwp.jp keys delete --key-id 123
確認をスキップ
xserver wphosting --contract-id WP-AB234567 ssh --servername xw123456.xwp.jp keys delete --key-id 123 -y

WordPressユーザー

権限グループ一覧を取得 xserver wphosting --contract-id <id> wp-users --servername <site> roles

指定サイトで利用可能な権限グループ一覧を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

権限一覧を取得
xserver wphosting --contract-id WP-AB234567 wp-users --servername xw123456.xwp.jp roles
ユーザー一覧を取得 xserver wphosting --contract-id <id> wp-users --servername <site> list [--search <value>] [--orderby <field>] [--order <order>]

WordPressユーザーを検索・並べ替えて取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--search <value>任意検索語
--orderby <field>任意ID / user_login / display_name / user_email / user_registered
--order <order>任意asc / desc

使用例

ログイン名順で取得
xserver wphosting --contract-id WP-AB234567 wp-users --servername xw123456.xwp.jp list --orderby user_login --order asc
ユーザーを作成 xserver wphosting --contract-id <id> wp-users --servername <site> create --user-login <login> --user-email <email> --user-pass <password> --role <role> [options]

WordPressユーザーを作成します。パスワードはコマンド履歴やログへ残さず、安全な入力・保管方法を使用してください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--user-login <login>必須1~60文字。英数字・_・-・.・@
--user-email <email>必須メール形式、100文字以内
--user-pass <password>必須7~64文字の秘密値
--role <role>必須1~64文字。rolesで取得した権限グループ
--display-name <name>任意1~255文字
--first-name <name>任意1~255文字
--last-name <name>任意1~255文字
--user-url <url>任意1~255文字
--send-email <bool>任意true / false

使用例

ユーザーを作成
xserver wphosting --contract-id WP-AB234567 wp-users --servername xw123456.xwp.jp create --user-login editor1 --user-email editor@example.com --user-pass "<secret>" --role editor
ユーザー詳細を取得 xserver wphosting --contract-id <id> wp-users --servername <site> show --user-id <id>

指定したWordPressユーザーの詳細を取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--user-id <id>必須正の整数

使用例

ユーザー詳細を取得
xserver wphosting --contract-id WP-AB234567 wp-users --servername xw123456.xwp.jp show --user-id 123
ユーザーを部分更新 xserver wphosting --contract-id <id> wp-users --servername <site> update --user-id <id> [options]

ユーザー情報を変更します。--user-email、--user-pass、--role、--display-name、--first-name、--last-name、--user-urlのうち少なくとも1項目を指定してください。パスワードはコマンド履歴やログへ残さないでください。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--user-id <id>必須正の整数
--user-email <email>任意メール形式、100文字以内
--user-pass <password>任意7~64文字の秘密値
--role <role>任意1~64文字
--display-name <name>任意1~255文字
--first-name <name>任意1~255文字
--last-name <name>任意1~255文字
--user-url <url>任意1~255文字

使用例

表示名を更新
xserver wphosting --contract-id WP-AB234567 wp-users --servername xw123456.xwp.jp update --user-id 123 --display-name "Editor"
ユーザーを削除 xserver wphosting --contract-id <id> wp-users --servername <site> delete --user-id <id> [options]

ユーザー詳細を確認対象として表示し、既定では No(いいえ)の確認後に削除します。所有する投稿なども削除されます。--yesで確認を省略できます。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--user-id <id>必須正の整数
-y, --yes任意確認プロンプトをスキップ

使用例

対象を確認して削除
xserver wphosting --contract-id WP-AB234567 wp-users --servername xw123456.xwp.jp delete --user-id 123
確認をスキップ
xserver wphosting --contract-id WP-AB234567 wp-users --servername xw123456.xwp.jp delete --user-id 123 -y

WordPressセキュリティ

セキュリティ設定を取得 xserver wphosting --contract-id <id> security --servername <site> list

変更可能なWordPressセキュリティ設定と、設定変更に使用するキーを取得します。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)

使用例

設定一覧を取得
xserver wphosting --contract-id WP-AB234567 security --servername xw123456.xwp.jp list
セキュリティ設定を変更 xserver wphosting --contract-id <id> security --servername <site> update --key <key> --enabled <bool>

security listで取得した設定キーの有効状態を変更します。キーは小文字英数字と_の100文字以内です。

オプション

オプション必須説明
--contract-id <id>必須WP- で始まる英数字の契約ID(64文字以内。全コマンドで必須)
--servername <site>必須サイト一覧で取得したサイト環境の識別子(*.xwp.jp)
--key <key>必須security listで取得した小文字英数字・_の設定キー(100文字以内)
--enabled <bool>必須true / false

使用例

設定を有効化
xserver wphosting --contract-id WP-AB234567 security --servername xw123456.xwp.jp update --key foreign_ip_restriction_restapi --enabled true