Command Index - Dify Docs

To see a command’s flags, run difyctl help <command>. In a command, <mode> is the app’s type, such as workflow or advanced_chat. help lists the types each command takes, and Find Your Apps maps each one to its app type.

Command	What it does	Requires
`login`	Sign in through your browser
`logout`	Sign out, ending this machine’s session on the server
`describe account`	Show the account you’re signed in as
`get account session`	List your sign-in sessions
`delete account session`	End one of your sessions
`delete account current_session`	End the session you’re running it with

Workspaces and Members

Command	What it does	Requires
`get workspace`	List your workspaces and their IDs
`describe workspace`	Show details of the workspace `difyctl` is in
`use workspace` Cloud	Switch `difyctl` to another of your workspaces
`get workspace member`	List your workspace’s members
`invite workspace member`	Invite someone by email	Admin or above
`set workspace member_role`	Change a member’s role	Admin or above
`delete workspace member`	Remove a member	Admin or above

Find and Inspect Apps

Command	What it does	Requires
`get console_app`	List your apps with Service API access on. Filter by name or type
`describe console_app`	Show an app’s details and the inputs it takes	Service API access on
`describe app_info <mode>`	Show an app’s name, description, and icon

Run Apps

Command	What it does	Requires
`run console_app <mode>`	Run an app and get its result	Service API access on
`upload console_app file`	Upload a file to pass to a later run	Service API access on
`stop run`	Stop a run that’s still going or paused at a Human Input form	Service API access on, Workflow and Chatflow apps only
`stop task`	Stop a reply that’s still streaming	Service API access on; Chatbot, legacy Agent, and Text Generator apps only
`get run event`	Follow a workflow run’s events	Service API access on
`describe run form`	Show the Human Input form a run paused at	Service API access on
`submit run form`	Answer a Human Input form	Service API access on
`get run`	List an app’s runs, newest first	Service API access on, Workflow and Chatflow apps only
`describe run`	Show one run’s inputs, outputs, error, and timing	Service API access on, Workflow and Chatflow apps only
`get run node`	Show each node’s step in a run, to find the one that failed	Service API access on, Workflow and Chatflow apps only

Build and Change Apps

Command	What it does	Requires
`create console_app <mode>`	Create a blank Workflow app, or a Chatflow app with a starter draft	Editor or above
`set app_info <mode>`	Change an app’s name, description, or icon	Editor or above
`import console_app dsl`	Create or update an app from a DSL file	Editor or above
`check console_app dsl`	Check a DSL file for problems without importing it	Editor or above
`confirm console_app dsl_import`	Finish an import waiting for confirmation, such as a file from a newer Dify version	Editor or above
`export console_app dsl`	Export an app’s DSL	Service API access on, Editor or above
`check console_app dependency`	List the integrations an app needs that your workspace doesn’t have	Service API access on, Editor or above
`get console_app env`	List the draft’s environment variables, with secret values masked	Service API access on, Editor or above, Workflow and Chatflow apps only
`set console_app env`	Add or change an environment variable	Service API access on, Editor or above, Workflow and Chatflow apps only
`delete console_app env`	Remove an environment variable	Service API access on, Editor or above, Workflow and Chatflow apps only
`test console_app <mode>`	Test-run the draft. A run that pauses at a Human Input form can’t be continued from `difyctl`	Service API access on, Editor or above
`test node <mode>`	Test one node of the draft	Service API access on, Editor or above
`get node_type`	List the node types your server can run
`describe node_type`	Show a node type’s settings and defaults
`get knowledge_base`	List the knowledge bases you can use in a workflow

Publish and Roll Back

Command	What it does	Requires
`check console_app release`	Check that the draft is ready to publish, and see what changed	Service API access on, Editor or above, Workflow and Chatflow apps only
`publish console_app`	Publish the draft	Service API access on, Editor or above, Workflow and Chatflow apps only
`get console_app version`	List published versions, newest first	Service API access on, Editor or above, Workflow and Chatflow apps only
`restore console_app version`	Copy a published version into the draft. Publish to make it live	Service API access on, Editor or above, Workflow and Chatflow apps only

Web App and Service API

Command	What it does	Requires
`describe webapp <mode>`	Show whether the app’s web app is on, its URL, and its page settings
`set webapp <mode>`	Change the web app’s settings	Editor or above
`reset webapp`	Give the web app a new URL. The old URL stops working	Admin or above
`describe service_api`	Show whether the app’s Service API access is on, and its base URL	Editor or above
`set service_api`	Turn the app’s Service API access on or off	Admin or above

Integrations

Command	What it does	Requires
`get marketplace plugin`	Search the Marketplace for integrations
`get plugin`	List the integrations installed in your workspace
`install plugin`	Install integrations from the Marketplace. The install finishes in the background	Permission to install integrations in your workspace
`describe plugin task`	Check an install’s progress	Permission to install integrations in your workspace
`delete plugin`	Uninstall an integration	Permission to install integrations in your workspace
`get tool`	List the tools a workflow can use
`describe tool_provider`	Show a tool provider’s credential form and saved credentials
`create tool_provider credential`	Save an API key for a tool provider	Admin or above
`set tool_provider credential`	Replace a saved tool provider credential	Admin or above
`get model`	List models, and whether each can be used now
`describe model_provider`	Show a model provider’s credential form and saved credentials
`create model_provider credential`	Save a credential for a model provider	Admin or above
`set model_provider credential`	Replace a saved model provider credential	Admin or above
`create model credential`	Save a credential for one model, such as one served by Ollama	Admin or above
`set model credential`	Replace a saved credential for one model	Admin or above

Workspace Skills Self-Hosted

These commands manage your workspace’s skills. To install the difyctl skill into your coding agent instead, run install skills.

Command	What it does	Requires
`get skill`	List your workspace’s skills. Filter by keyword, by tags, or both
`describe skill`	Show a skill’s details, including its latest version and its `draft_hash`
`get skill version`	List a skill’s published versions
`export skill`	Download a skill as a zip file: its draft, or a published version with `--version-id` from `get skill version`
`import skill`	Create a skill from a folder, or pass `--skill-id` to replace an existing skill’s draft with the folder. Draft files the folder doesn’t have are removed. To guard against overwriting changes made to the skill since you read it, add `--draft-hash` from `describe skill`	Editor or above
`publish skill`	Publish a skill’s draft as a new version	Editor or above

Agent Knowledge Bases Cloud

The knowledge_fs commands read an agent knowledge base you can view in Dify. For how to point your coding agent at one, see From Your Coding Agent.

Command	What it does	Requires
`knowledge_fs ls`	List a knowledge base’s documents, or the sections of one
`knowledge_fs tree`	Show documents and their sections as one nested list
`knowledge_fs find`	Find documents by name or metadata
`knowledge_fs grep`	Search documents for exact words
`knowledge_fs cat`	Print a document or one of its sections
`knowledge_fs stat`	Show a document’s details, such as whether it finished processing
`knowledge_fs diff`	Compare two documents

Local Settings and Help

Command	What it does	Requires
`help`	Find commands and see their flags
`version`	Show the `difyctl` and server versions
`get config`, `set config`, `unset config`	Show, change, or reset how long `difyctl` waits for the server
`refresh cache`	Fetch your server’s command list again, such as after a server upgrade
`delete cache`	Delete the cached command list
`install skills`	Install the `difyctl` skill into a coding agent’s skills folder

Last modified on November 4, 2026