Skip to main content

このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。

インストールオプション#

インストールコマンド に次の変数を設定します：

変数説明例
DIFY_VERSIONdifyctl のインストール元となる Dify リリース。サーバーのバージョンを指定する。

既定値は Dify の最新リリース。		1.18.0
DIFYCTL_PREFIXインストール先ディレクトリ。バイナリは <prefix>/bin に配置される。このフォルダが PATH に含まれていない場合は追加する。

既定値は、macOS と Linux では ~/.local、Windows では %LOCALAPPDATA%\difyctl。		$HOME/tools
GITHUB_TOKEN または GH_TOKENGitHub トークン。スコープは不要。GitHub のリクエスト上限（1 時間あたり 60 回）でインストーラーが止まった場合に設定する。この上限は、同じ IP アドレスを使う全員で共有される。

たとえば、Dify 1.18.0 のビルドを ~/tools/bin にインストールするには、次のように実行します：

環境変数#

次の変数は、difyctl を実行するシェルまたはジョブで設定します：

変数説明
DIFY_CONFIG_DIR既定のフォルダ の代わりに使う設定フォルダ。複数のサーバーに同時にサインインしておく には、サーバーごとに別のフォルダを指定する。
DIFY_OUTPUTエラーと help の出力形式。json または text を指定する。未設定の場合、ターミナルではテキスト、ファイルや別のプログラムに送る場合は JSON になる。結果は常に JSON で出力される。スクリプトでは DIFY_OUTPUT=json を設定して、どこで実行してもエラーが JSON で出力されるようにする。

--json は DIFY_OUTPUT=text より優先される。
DIFY_SERVERコマンドの送信先サーバーのアドレス（https://dify.example.com など）。DIFY_TOKEN と一緒に設定した場合にのみ使われる。
DIFY_TOKENdifyctl のサインインで得たトークン。DIFY_SERVER、DIFY_WORKSPACE_ID とあわせて設定すると、コマンドは保存済みのサインイン情報の代わりにこれらの値を使う。DIFY_TOKEN を設定している間は、login と logout を実行できない。

DIFY_SERVER を設定していないと、コマンドは 終了コード 2 で失敗する。DIFY_WORKSPACE_ID を設定していないと、ワークスペースを対象とするコマンドが失敗する。

ジョブ用のトークンを取得して安全に保管する方法は、CI と自動化での difyctl の使用 を参照。
DIFY_WORKSPACE_IDget console_app など、ワークスペースを対象とするコマンドで使うワークスペースの ID。difyctl get workspace の一覧では id として表示される。環境変数によるサインインには保存済みのワークスペースがないため、DIFY_TOKEN を設定するときは必ずこの変数も設定する。

--workspace-id はこの変数より優先され、この変数は保存済みのサインイン情報にあるワークスペースより優先される。
HTTP_PROXY、HTTPS_PROXY、NO_PROXYdifyctl のリクエストを経由させるプロキシ。https:// のサーバーには HTTPS_PROXY、http:// のサーバーには HTTP_PROXY を使う。小文字の http_proxy と https_proxy も使える。

社内サーバーなど、特定のサーバーでプロキシを使わない場合は、そのホストを NO_PROXY（または no_proxy）に指定する。
NO_COLOR1 など任意の値を設定すると、ターミナルに表示されるテキストの色付けがオフになる。

設定項目#

http.timeout は、サーバーが応答を返し始めるまで difyctl が待つ時間をミリ秒単位で指定します。この時間を過ぎると、コマンドは失敗します。既定値は 30000 です。

サーバーやネットワークが遅かったり、大きなファイルを送信したりしてコマンドがタイムアウトする場合は、この値を大きくします。制限するのはサーバーの最初の応答までの待ち時間だけで、コマンド全体にかかる時間は制限しません。そのため、数分かかるアプリの実行でも、--stream の有無にかかわらず、値を大きくする必要はありません。

たとえば 60 秒に変更するには、次のように実行します：

既定値に戻すには、difyctl unset config http.timeout を実行します。現在の設定と、その保存先のファイルを確認するには、difyctl get config を実行します。

difyctl が保存するファイル#

difyctl は、設定フォルダ に次のファイルを保存します：

ファイル内容
login.yml保存済みのサインイン情報。サーバー、アカウント、ワークスペースと、トークンの保存場所。
login-pending.ymllogin --no-wait で開始したサインイン。login --resume で完了するまで保存される。
tokens.ymlOS のキーチェーンではなく ファイルに保存される 場合のトークン。
config.yml設定内容。いずれかの設定を変更すると、ここに保存される。
catalog/<server>.json使用するサーバーごとの、保存済みのコマンド一覧。削除しても問題ない。次にコマンドを実行すると再取得される。