mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-07-24 04:25:07 -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
117 lines
3.6 KiB
Plaintext
117 lines
3.6 KiB
Plaintext
---
|
|
title: Help
|
|
description: Get help in the terminal with per-command docs, guide topics, and machine-readable JSON
|
|
---
|
|
|
|
The `difyctl` help system covers four surfaces: the [top-level overview](#get-help), [per-command and group help](#help-for-one-command-or-group), [guide topics](#guide-topics), and a [machine-readable form](#machine-readable-help) of all of them. All help prints to stdout and exits `0`.
|
|
|
|
## Get Help
|
|
|
|
Four invocations show the same top-level overview:
|
|
|
|
```bash
|
|
difyctl
|
|
difyctl help
|
|
difyctl --help
|
|
difyctl -h
|
|
```
|
|
|
|
The overview lists every command with its one-liner, three getting-started examples, the [global flags](/en/cli/reference/global-flags), and the [guide topics](#guide-topics). For the same inventory with links into this reference, see the [Command Index](/en/cli/reference/command-index).
|
|
|
|
## Help for One Command or Group
|
|
|
|
Append `--help` to any command, or put `help` in front of it:
|
|
|
|
```bash
|
|
difyctl run app --help
|
|
difyctl help run app
|
|
```
|
|
|
|
Per-command help shows the command's description, usage line, arguments, flags with defaults, and examples.
|
|
|
|
Name a command group instead of a command to list the group's subcommands:
|
|
|
|
```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
|
|
```
|
|
|
|
A name that matches neither a command, a topic, nor a group fails with `unknown help topic: <name>`, suggestions, and exit code `1`.
|
|
|
|
## Guide Topics
|
|
|
|
Long-form topics ship inside the CLI, read with `difyctl help <topic>`:
|
|
|
|
| Topic | What it covers |
|
|
|:---|:---|
|
|
| `account` | Onboarding guidance. |
|
|
| `environment` | The CLI's own descriptions of the `DIFY_*` environment variables. |
|
|
| `agent` | The cross-command contract for agents driving `difyctl`. |
|
|
|
|
These topics are built into the CLI. For which variables `difyctl` actually reads, see [Environment Variables](/en/cli/reference/environment-variables).
|
|
|
|
## Machine-Readable Help
|
|
|
|
Every help surface accepts `-o json` and `-o yaml`. The top-level form emits the complete command surface in one document:
|
|
|
|
```bash
|
|
difyctl help -o json
|
|
```
|
|
|
|
The document has four top-level keys:
|
|
|
|
- `bin`, `contract`: exit codes, output formats, the shape of error output, and cross-command rules
|
|
- `commands`: one descriptor per command
|
|
- `topics`: the available guide topics by name, with each topic's text read via `difyctl help <topic>`
|
|
|
|
Per-command help in JSON returns just that command's descriptor:
|
|
|
|
```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
|
|
}
|
|
```
|
|
|
|
Each descriptor carries the command's arguments and flags with types and defaults, an `effect` label (`read`, `write`, or `destructive`), and an `agentGuide` string where one exists. This is how coding agents discover `difyctl`.
|
|
|
|
## Exit Codes
|
|
|
|
| Code | Meaning |
|
|
|:---|:---|
|
|
| `0` | Help printed |
|
|
| `1` | Unknown help topic or command name |
|
|
|
|
See [Output Formats and Exit Codes](/en/cli/reference/output-formats-and-exit-codes) for the full scheme.
|