Nextcloud

Nextcloudトップ > ニュース > ブログ > テックブログ > occコマンドの共通オプションについて

occコマンドの共通オプションについて

Nextcloudのoccコマンドは、Webインターフェースではできない高度な設定や、トラブルシューティング、バッチ処理などを効率的に行うことができます。本記事では、どのoccコマンドでも利用できる共通オプションについて解説します。

1. occコマンドについて

occコマンド（Nextcloud Command Line Interface）は、Nextcloudに組み込まれたコマンドラインツールで、管理者がシステムの設定や保守を行うための多機能なユーティリティです。PHPを利用して実装されており、通常は以下のような形式で実行します。

sudo -u www-data php /path/to/nextcloud/occ [command] [options]
  • www-data は、Webサーバの実行ユーザーを指定します (他の例: apache、nginx)
  • /path/to/nextcloud は、Nextcloudパッケージのインストールパスを指定します

2. occコマンドの共通オプション

--output

出力結果のフォーマットを指定できます。特にスクリプトで自動化する場合に便利です。
json は、実行結果をJSON形式で出力できますので、実行結果を他のアプリ、モジュールなどと連携して使うことができます。

$ sudo -u www-data php /var/www/html/nextcloud/occ status --output=json_pretty
{
    "installed": true,
    "version": "30.0.6.3",
    "versionstring": "30.0.6 Enterprise",
    "edition": "",
    "maintenance": false,
    "needsDbUpgrade": false,
    "productname": "Nextcloud",
    "extendedSupport": false
}

※指定できる主なフォーマット

  • plain（デフォルト）：通常のテキスト出力
  • json：JSON形式での出力
  • json_pretty：整形されたJSON形式。適度に改行が入って見やすくなります

--help / -h

コマンドの使い方や利用可能なオプションを表示します。

$ sudo -u www-data php /var/www/html/nextcloud/occ status --help
Description:
  show some status information

Usage:
  status [options]

Options:
      --output[=OUTPUT]  Output format (plain, json or json_pretty, default is plain) [default: "plain"]
  -e, --exit-code        exit with 0 if running in normal mode, 1 when in maintenance mode, 2 when `./occ upgrade` is needed. Does not write any output to STDOUT.
  -h, --help             Display help for the given command. When no command is given display help for the list command
  -q, --quiet            Do not output any message
  -V, --version          Display this application version
      --ansi|--no-ansi   Force (or disable --no-ansi) ANSI output
  -n, --no-interaction   Do not ask any interactive question
      --no-warnings      Skip global warnings, show command output only
  -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

--quiet / -q

コマンドの出力を最小限に抑えます。成功時のメッセージは表示されません。
エラーが発生した場合のみ出力があります。

--version / -V

現在のNextcloudバージョンを表示します。

$ sudo -u www-data php /var/www/html/nextcloud/occ status --version
Nextcloud 30.0.6 Enterprise

--ansi

コマンド出力をANSIエスケープコードでカラフルに表示します。

--no-ansi

コマンド出力をANSIエスケープコードを使わずに表示します。

--no-interaction / -n

対話的な入力を求められる場面で、デフォルト値を使用して自動的に処理を進めるオプションです。
スクリプトでの自動実行時に特に有用です。

--no-warnings

警告メッセージを非表示にします。
大量のコマンドを実行する際にログを整理するのに役立ちます。

--verbose / -v | -vv | -vvv

実行時の詳細情報を出力するレベルを設定できます。
トラブルシューティングや詳細な実行状況を確認したい場合に役立ちます。

  • -v：通常の詳細情報
  • -vv：より詳細な情報
  • -vvv: 最も詳細な情報（デバッグレベル）

3. まとめ

occコマンドの共通オプションを適切に活用することで、Nextcloudの管理作業が効率化できます。特に自動化スクリプトやバッチ処理を作成する際には、これらのオプションが大いに役立ちます。
日々の運用に取り入れて、より効率的なNextcloud管理を実現しましょう。

関連記事