mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-07-25 05:25:40 -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
91 lines
2.6 KiB
Plaintext
91 lines
2.6 KiB
Plaintext
---
|
|
title: Quick Start
|
|
description: Run your first Dify app from the command line in under 5 minutes
|
|
---
|
|
|
|
Before you start, make sure `difyctl` is [installed](/en/cli/install).
|
|
|
|
## Step 1: Sign In
|
|
|
|
1. Sign in to your Dify host.
|
|
|
|
For Dify Cloud, use `https://cloud.dify.ai`; on a self-hosted deployment, use the [console API URL](/en/self-host/deploy/configuration/environments#console_api_url).
|
|
|
|
```bash
|
|
difyctl auth login --host https://cloud.dify.ai
|
|
```
|
|
|
|
`difyctl` prints a one-time code and a verification URL, then waits:
|
|
|
|
```text
|
|
! Copy this one-time code: WDJP-XKLM
|
|
Open: https://cloud.dify.ai/device
|
|
```
|
|
|
|
2. Open the URL in a browser, enter the code, and sign in. Return to the terminal and you'll see:
|
|
|
|
```text
|
|
✓ Logged in to cloud.dify.ai as <your-email> (<your-name>)
|
|
Workspace: <your-workspace>
|
|
```
|
|
|
|
## Step 2: Find Your App
|
|
|
|
List the apps in your workspace:
|
|
|
|
```bash
|
|
difyctl get app
|
|
```
|
|
|
|
You should see something like this:
|
|
|
|
```text
|
|
NAME ID MODE UPDATED
|
|
Customer FAQ 0a1b2c3d-4e5f-6789-abcd-ef0123456789 chat 2026-06-08T03:14:27.521839
|
|
Daily Report 7f3e9a2b-1c4d-4e8f-9a0b-2d5c8e1f4a7b workflow 2026-06-05T22:41:09.812016
|
|
```
|
|
|
|
Copy the ID of the app you want to run. The examples below use the two IDs from this table.
|
|
|
|
## Step 3: Run Your App
|
|
|
|
How you pass input depends on the app type.
|
|
|
|
<Tabs>
|
|
<Tab title="Chatbot / Chatflow / Agent / Text Generator">
|
|
Pass your message as a positional argument:
|
|
|
|
```bash
|
|
difyctl run app 0a1b2c3d-4e5f-6789-abcd-ef0123456789 "What are your business hours?"
|
|
```
|
|
|
|
The reply prints to stdout. For Chatbot, Chatflow, and Agent apps, a hint also prints to stderr so you can continue the same conversation later:
|
|
|
|
```text
|
|
Our business hours are Monday through Friday, 9am to 6pm PT.
|
|
|
|
hint: continue this conversation with --conversation 4f7d8c2a-9b1e-4c6d-8a3f-5e2b7c9d0a1f
|
|
```
|
|
|
|
</Tab>
|
|
<Tab title="Workflow">
|
|
Pass inputs as a single JSON object with `--inputs`:
|
|
|
|
```bash
|
|
difyctl run app 7f3e9a2b-1c4d-4e8f-9a0b-2d5c8e1f4a7b --inputs '{"topic":"quarterly report","audience":"executives"}'
|
|
```
|
|
|
|
The workflow's outputs print to stdout as JSON:
|
|
|
|
```json
|
|
{"summary":"Q3 revenue grew 14% YoY...","sections":["revenue","costs","outlook"]}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next Steps
|
|
|
|
- **The everyday commands, copy-paste ready**: [Common Tasks](/en/cli/common-tasks)
|
|
- **Where your token lives and how sessions work**: [Authenticate](/en/cli/authenticate)
|
|
- **Everything else you can do with `difyctl`**: [Command Index](/en/cli/reference/command-index)
|