mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-07-22 12:25:45 -04:00
Riskey
2f88f0f7d2
* docs: add Human Input file inputs and Service API to Cloud docs Port the Phase 2 Human Input docs (file inputs and the Service API integration flow) to the Cloud docs, mirroring the self-host pages. - human-input.mdx (en/zh/ja): add the Single File / File List field type and the file-handling notes; the upload-limit callout states Cloud's fixed limits (documents 15 MB, images 10 MB, audio 50 MB, video 100 MB, up to 10 files) instead of self-host env vars. - hitl-api-integration-flow.mdx (en/zh/ja): new; identical to self-host since the Service API is the same. - docs.json: nest the integration-flow under the Human Input group in all three navs. - zh/ja reuse the self-host translations; only the callout and the /self-host/ links changed. * docs: rewrite Cloud model providers around AI Credits * docs: rewrite Cloud subscription management for 1.15.0 * docs: update Cloud code node limits and XLSX image extraction note * docs: rewrite Cloud team members management for 1.15.0 * docs: apply the 1.15.0 Integrations redesign to Cloud docs * docs: fix workflow API reference for run-level logs and streaming * docs: sync self-host use-dify pages and fix translation debt * docs: align shared tutorials and quick start with 1.15.0 * docs: refine difyctl install examples and workspace reference * docs: rewrite hotkeys page to match current shortcuts * fix: correct broken anchor links for badged headings and tabs * fix: correct env link and Human Input resume identifier * feat: handle heading badges in link-checker slugs * fix: repoint publish-mcp cross-links to the merged MCP section * docs: rename plugin dev CLI to Dify Plugin CLI * docs: refine CLI reference readability and expand --agent * feat: stop format checkers flagging indented list-item content * fix: correct zh/ja custom-endpoint spacing and a list blank line * docs: clarify Cloud model provider install and AI Credits coverage
119 lines
4.9 KiB
Plaintext
119 lines
4.9 KiB
Plaintext
---
|
|
title: ヘルプ
|
|
description: コマンドごとのドキュメント、ガイドトピック、機械可読な JSON をターミナルで取得
|
|
---
|
|
|
|
> このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、[英語版](/en/cli/reference/help) を参照してください。
|
|
|
|
`difyctl` のヘルプシステムは 4 つの領域をカバーします。[トップレベルの概要](#ヘルプの表示)、[コマンドまたはグループごとのヘルプ](#コマンドまたはグループごとのヘルプ)、[ガイドトピック](#ガイドトピック)、そしてそれらすべての [機械可読な形式](#機械可読ヘルプ) です。ヘルプはすべて stdout に出力され、終了コード `0` で終了します。
|
|
|
|
## ヘルプの表示
|
|
|
|
次の 4 つの呼び出し方法は、いずれも同じトップレベルの概要を表示します。
|
|
|
|
```bash
|
|
difyctl
|
|
difyctl help
|
|
difyctl --help
|
|
difyctl -h
|
|
```
|
|
|
|
概要には、各コマンドとその概要、3 つの入門例、[グローバルフラグ](/ja/cli/reference/global-flags)、[ガイドトピック](#ガイドトピック) が一覧表示されます。この一覧に本リファレンスへのリンクを添えたものは、[コマンドインデックス](/ja/cli/reference/command-index) を参照してください。
|
|
|
|
## コマンドまたはグループごとのヘルプ
|
|
|
|
任意のコマンドに `--help` を付けるか、コマンドの前に `help` を置きます。
|
|
|
|
```bash
|
|
difyctl run app --help
|
|
difyctl help run app
|
|
```
|
|
|
|
コマンドごとのヘルプには、そのコマンドの説明、使用法の行、引数、デフォルト値付きのフラグ、例が表示されます。
|
|
|
|
コマンドではなくコマンドグループを指定すると、そのグループのサブコマンドが一覧表示されます。
|
|
|
|
```bash
|
|
difyctl auth --help
|
|
```
|
|
|
|
```text
|
|
COMMANDS
|
|
auth devices list List active sessions for the current bearer
|
|
auth devices revoke Revoke one or all session devices
|
|
auth list List all authenticated contexts (host + account pairs)
|
|
auth login Sign in to Dify via OAuth device flow
|
|
auth logout Log out of the active Dify host
|
|
auth whoami Print the active subject's identity
|
|
```
|
|
|
|
コマンド、トピック、グループのいずれにも一致しない名前は、`unknown help topic: <name>` と候補を表示し、終了コード `1` で失敗します。
|
|
|
|
## ガイドトピック
|
|
|
|
長文のトピックは CLI に同梱されており、`difyctl help <topic>` で読みます。
|
|
|
|
| トピック | 内容 |
|
|
|:---|:---|
|
|
| `account` | オンボーディングのガイダンス。 |
|
|
| `environment` | `DIFY_*` 環境変数に関する CLI 自身の説明。 |
|
|
| `agent` | `difyctl` を駆動する Agent 向けのコマンド横断の規約。 |
|
|
|
|
これらのトピックは CLI に組み込まれています。`difyctl` が実際に読み取る変数については、[環境変数](/ja/cli/reference/environment-variables) を参照してください。
|
|
|
|
## 機械可読ヘルプ
|
|
|
|
すべてのヘルプ領域が `-o json` と `-o yaml` を受け付けます。トップレベルの形式は、コマンドの全体像を 1 つのドキュメントとして出力します。
|
|
|
|
```bash
|
|
difyctl help -o json
|
|
```
|
|
|
|
このドキュメントには 4 つのトップレベルキーがあります。
|
|
|
|
- `bin`、`contract`：終了コード、出力形式、エラー出力の構造、コマンド横断のルール
|
|
- `commands`：コマンドごとに 1 つのディスクリプタ
|
|
- `topics`：利用可能なガイドトピックを名前ごとに示し、各トピックの本文は `difyctl help <topic>` で読み取る
|
|
|
|
JSON 形式のコマンドごとのヘルプは、そのコマンドのディスクリプタのみを返します。
|
|
|
|
```bash
|
|
difyctl auth whoami --help -o json
|
|
```
|
|
|
|
```json
|
|
{
|
|
"command": "auth whoami",
|
|
"description": "Print the active subject's identity",
|
|
"effect": "read",
|
|
"args": [],
|
|
"flags": [
|
|
{
|
|
"name": "json",
|
|
"char": null,
|
|
"type": "boolean",
|
|
"default": false,
|
|
"multiple": false,
|
|
"options": null,
|
|
"description": "emit JSON"
|
|
}
|
|
],
|
|
"examples": [
|
|
"difyctl auth whoami",
|
|
"difyctl auth whoami --json"
|
|
],
|
|
"agentGuide": null
|
|
}
|
|
```
|
|
|
|
各ディスクリプタには、型とデフォルト値を含むコマンドの引数とフラグ、`effect` ラベル（`read`、`write`、`destructive`）、存在する場合は `agentGuide` 文字列が含まれます。コーディング Agent はこの仕組みで `difyctl` を検出します。
|
|
|
|
## 終了コード
|
|
|
|
| コード | 意味 |
|
|
|:---|:---|
|
|
| `0` | ヘルプを出力 |
|
|
| `1` | 不明なヘルプトピックまたはコマンド名 |
|
|
|
|
完全な体系については、[出力形式と終了コード](/ja/cli/reference/output-formats-and-exit-codes) を参照してください。
|