用法: [选项] 命令 [参数]...

选项: --version --use-feature TEXT -v, --verbose --help 显示此消息并退出

命令:

backup-all-sites

描述: 备份当前 bench 中的所有站点。 用法: bench backup-all-sites 说明: 此命令用于备份当前 bench 中的所有站点。它会遍历 bench 中的每个站点，并对其进行备份，以确保在需要时可以恢 复站点数据。这是保护数据安全和防止意外数据丢失的重要操作。 描述: 更改 bench 配置。

config

描述: 更改 bench 配置。 用法: bench config 说明: 此命令用于更改 bench 的配置。通过运行此命令，你可以修改 bench 的各种配置选项，包括数据库连接、环境变量、Web 服务器配置等。这允许你根据需要自定义 bench 环境，以适应特定的开发或生产要求。

disable-production

描述: 禁用 bench 的生产环境。 用法: bench disable-production 说明: 此命令用于禁用 bench 的生产环境。生产环境通常配置为适用于实际部署和运行的设置，包括性能优化、安全设置等。通过禁用生产环境，你可以将 bench 切换到更适合开发、测试或调试的模式，以便更轻松地进行开发和调整配置。

download-translations

描述: 下载最新的翻译。 用法: bench download-translations 说明: 此命令用于下载最新的翻译文件。通常，软件应用程序会提供多语言支持，而翻译文件包含了不同语言的文本翻译。通过运行此命令，你可以获取最新的翻译文件，确保应用程序以多种语言提供给用户。这有助于增强应用程序的可用性和用户体验。

drop

描述: 删除 bench 中的特定数据库。 用法: bench drop [db_name] 说明: 此命令用于删除 bench 中特定的数据库。你需要提供要删除的数据库名称 [db_name]。注意，删除数据库将永久丢失所有相关数据，因此请谨慎使用此命令。通常在需要清理测试数据或不再需要的数据库时使用。

exclude-app

描述: 排除应用程序不进行更新。 用法: bench exclude-app [app_name] 说明: 此命令用于将指定的应用程序排除在更新之外，即在 bench 更新时不对该应用程序进行更新。这对于一些特定应用程序可能需要手动管理更新的情况很有用，可以避免不需要的更新对系统造成影响。你需要替换 [app_name] 为要排除的应用程序的名称。

find

描述: 从指定位置递归查找 benches。 用法: bench find [location] 说明: 此命令用于从指定位置递归查找 benches。bench 是 Frappe 框架的管理工具，可以用于多个站点的管理。通过运行此命令并提供要查找 benches 的起始位置，你可以在该位置及其子目录中递归查找 benches，以便对这些 benches 进行操作或管理。你需要替换 [location] 为要开始查找的位置。

get

描述: 从互联网或文件系统克隆一个应用程序。 用法: bench get [app_name] [--branch <branch_name>] [--dev] [--username ] [--password ] 说明: 此命令用于从互联网或文件系统克隆一个应用程序，可以将该应用程序添加到 bench 环境中。你可以通过提供应用程序名称 [app_name] 进行克隆。可选的参数包括克隆特定分支 --branch、开发模式 --dev、用户名 --username 和密码 --password。这允许你方便地获取应用程序并将其集成到你的 bench 环境中。

get-app

描述: 从互联网或文件系统克隆一个应用程序。 用法: bench get-app [app_name] [--branch <branch_name>] [--dev] [--shallow-clone] 说明: 此命令用于从互联网或文件系统克隆一个应用程序，并将其添加到 bench 环境中。你可以通过提供应用程序名称 [app_name] 进行克隆。可选的参数包括克隆特定分支 --branch、开发模式 --dev、以及浅克隆 --shallow-clone。浅克隆只克隆最近的历史记录，可以加快克隆速度。这使得你可以方便地获取应用程序并将其集成到你的 bench 环境中。

include-app

描述: 包含应用程序以进行更新。 用法: bench include-app [app_name] 说明: 此命令用于将指定的应用程序包含在更新中，即在 bench 更新时对该应用程序进行更新。默认情况下，bench 更新将包括所有已安装的 Frappe 应用程序，但通过运行此命令并指定 [app_name]，你可以将特定应用程序包含在更新中，确保其也会被更新。你需要替换 [app_name] 为要包含的应用程序的名称。

init

描述: 在指定路径初始化一个新的 bench 实例。 用法: bench init [PATH] [--python <python_executable>] [--ignore-exist] [--apps_path <apps_path>] 说明: 此命令用于在指定的路径 [PATH] 初始化一个新的 bench 实例。可以通过提供 [PATH] 指定 bench 实例的安装路径。可选的参数包括指定 Python 可执行文件路径 --python、忽略如果 bench 实例已存在 --ignore-exist，以及指定 apps 路径 --apps_path。这允许你在指定位置创建新的 bench 实例，并进行相关的配置和管理。

install

描述: 安装用于设置 bench 环境的系统依赖项。 用法: bench install 说明: 此命令用于安装 bench 环境所需的系统依赖项。bench 是 Frappe 框架的管理工具，用于开发和管理应用程序。在运行 bench 之前，需要确保系统已经安装了一些特定的依赖项，以保证 bench 可以正常工作。通过运行此命令，你可以方便地安装这些依赖项，以确保 bench 的正常运行和使用。

migrate-env

描述: 将虚拟环境迁移到所需的 Python 版本。 用法: bench migrate-env [Python_version] 说明: 此命令用于将 bench 中的虚拟环境迁移到指定的 Python 版本。你需要提供目标 Python 版本 [Python_version]。虚拟环境迁移是为了确保 bench 的虚拟环境与指定的 Python 版本兼容，以满足应用程序的特定要求。这个命令允许你在需要时更改 bench 的 Python 版本。

new-app

描述: 在 apps 文件夹下创建一个新的 Frappe 应用程序。 用法: bench new-app [app_name] 说明: 此命令用于在 Frappe 的 apps 文件夹下创建一个新的应用程序。你需要提供要创建的应用程序的名称 [app_name]。通过运行此命令，你可以方便地创建新的应用程序，并在之后进行开发和定制。创建应用程序是构建基于 Frappe 框架的应用的第一步。

pip

描述: 使用当前 bench 的 pip 管理 Python 包。 用法: bench pip [COMMAND] [OPTIONS] 说明: 此命令用于使用 bench 的 pip 来管理 Python 包。你可以通过提供相应的命令 [COMMAND] 和选项 [OPTIONS] 来使用 pip。例如，你可以运行 bench pip install <package_name> 来安装 Python 包。如果需要 pip 帮助，你可以运行 bench pip help [COMMAND] 或 bench pip [COMMAND] -h 来获取更多信息。pip 是 Python 的软件包管理器，用于安装、升级、卸载 Python 包及其依赖。

remote-reset-url

描述: 将应用程序的远程 URL 重置为 Frappe 官方 URL。 用法: bench remote-reset-url [app_name] 说明: 此命令用于将特定应用程序的远程 URL 重置为 Frappe 官方 URL。通常，在开发或定制应用程序时，可能需要修改应用程序的远程 URL，但有时你可能想要将其恢复为 Frappe 官方 URL。通过运行此命令并提供应用程序名称 [app_name]，你可以将指定应用程序的远程 URL 重置为 Frappe 官方 URL。

remote-set-url

描述: 设置应用程序的远程 URL。 用法: bench remote-set-url [app_name] [remote_url] 说明: 此命令用于设置特定应用程序的远程 URL。通常，在开发或定制应用程序时，你可能需要指定自定义的远程 URL。通过运行此命令并提供应用程序名称 [app_name] 和自定义的远程 URL [remote_url]，你可以将特定应用程序的远程 URL 设置为你指定的 URL。这允许你自定义应用程序的源，以满足特定需求。

remote-urls

描述: 显示应用程序的远程 URL。 用法: bench remote-urls 说明: 此命令用于显示 bench 中所有应用程序的远程 URL。远程 URL 是指向应用程序源代码的位置，通常是一个 Git 仓库的 URL。通过运行此命令，你可以查看 bench 中所有应用程序的远程 URL，了解它们的源代码位置。这对于了解应用程序的来源以及管理不同应用程序的源代码很有用。

remove

描述: 从 bench 中完全移除指定应用程序，并重新构建 bench。 用法: bench remove [app_name] [--no-backup] 说明: 此命令用于从 bench 中彻底移除指定的应用程序，同时重新构建 bench。可选的参数 --no-backup 可以选择不备份应用程序数据。通过运行此命令并提供应用程序名称 [app_name]，你可以将指定应用程序从 bench 中移除，也可以选择是否备份应用程序数据。这允许你在不需要某个应用程序时从 bench 中将其移除。

remove-app

描述: 从 bench 中完全移除指定应用程序，并重新构建 bench。 用法: bench remove-app [app_name] [--no-backup] 说明: 此命令用于从 bench 中彻底移除指定的应用程序，同时重新构建 bench。可选的参数 --no-backup 可以选择不备份应用程序数据。通过运行此命令并提供应用程序名称 [app_name]，你可以将指定应用程序从 bench 中移除，也可以选择是否备份应用程序数据。这允许你在不需要某个应用程序时从 bench 中将其移除。

renew-lets-encrypt

描述: 设置最新的定时任务并续订 Let's Encrypt SSL 证书。 用法: bench renew-lets-encrypt [site_name] 说明: 此命令用于设置最新的定时任务，以自动续订 Let's Encrypt SSL 证书。SSL 证书是用于加密网站传输的安全协议，Let's Encrypt 是一个免费的证书颁发机构。通过运行此命令并提供站点名称 [site_name]，你可以设置自动定时任务以在 SSL 证书过期前自动续订证书，保证网站的安全连接。

restart

描述: 重新启动 supervisor 进程或 systemd 单元。 用法: bench restart 说明: 此命令用于重新启动 supervisor 进程或 systemd 单元，以使相关服务或进程生效。Supervisor 是一个进程控制系统，用于监控和管理进程，而 systemd 是一个系统和服务管理器。通过运行此命令，你可以重新启动这些进程或单元，确保系统中的服务处于最新状态。这对于应用程序的更新和配置更改后生效非常有用。

retry-upgrade

描述: 重试升级失败的操作。 用法: bench retry-upgrade 说明: 此命令用于重试之前失败的升级操作。有时，在升级 bench 或应用程序时可能会发生失败，可能是由于网络问题、依赖关系等原因。通过运行此命令，你可以重试之前失败的升级操作，以尝试解决这些问题并成功完成升级。这可以确保 bench 及其应用程序保持最新状态。

rm

描述: 从 bench 中完全移除指定应用程序，并重新构建 bench。 用法: bench rm [app_name] [--force] [--no-backup] 说明: 此命令用于从 bench 中彻底移除指定的应用程序，同时重新构建 bench。可选的参数 --force 可以强制移除应用程序，而 --no-backup 可以选择不备份应用程序数据。通过运行此命令并提供应用程序名称 [app_name]，你可以将指定应用程序从 bench 中移除，也可以选择是否备份应用程序数据。这允许你在不需要某个应用程序时从 bench 中将其移除。

set-mariadb-host

描述: 为 bench 设置 MariaDB 主机。 用法: bench set-mariadb-host [host] 说明: 此命令用于为 bench 设置 MariaDB 数据库的主机。MariaDB 是一个流行的开源关系型数据库管理系统。通过运行此命令并提供 MariaDB 主机的地址 [host]，你可以设置 bench 使用的 MariaDB 数据库的主机。这对于配置 bench 使用特定 MariaDB 实例非常有用。

set-nginx-port

描述: 为站点设置 NGINX 端口。 用法: bench set-nginx-port [site_name] [port] 说明: 此命令用于为特定站点设置 NGINX 服务的端口。NGINX 是一个高性能的开源 Web 服务器。通过运行此命令并提供站点名称 [site_name] 和要设置的端口 [port]，你可以配置该站点在 NGINX 上的端口。这允许你自定义站点的访问端口。

set-redis-cache-host

描述: 为 bench 设置 Redis 缓存主机。 用法: bench set-redis-cache-host [host] 说明: 此命令用于为 bench 设置 Redis 缓存的主机。Redis 是一个高性能的开源内存数据库。通过运行此命令并提供 Redis 缓存的主机地址 [host]，你可以配置 bench 使用的 Redis 缓存的主机。这对于配置 bench 使用特定 Redis 实例以加速缓存非常有用。

set-redis-queue-host

描述: 为 bench 设置 Redis 队列主机。 用法: bench set-redis-queue-host [host] 说明: 此命令用于为 bench 设置 Redis 队列的主机。Redis 是一个高性能的开源内存数据库，用于实现消息队列等应用。通过运行此命令并提供 Redis 队列的主机地址 [host]，你可以配置 bench 使用的 Redis 队列的主机。这对于配置 bench 使用特定 Redis 实例以进行队列处理非常有用。

set-redis-socketio-host

描述: 为 bench 设置 Redis Socket.IO 主机。 用法: bench set-redis-socketio-host [host] 说明: 此命令用于为 bench 设置 Redis Socket.IO 的主机。Socket.IO 是一个实时网络库，用于实现实时通信。通过运行此命令并提供 Redis Socket.IO 的主机地址 [host]，你可以配置 bench 使用的 Redis Socket.IO 的主机。这对于配置 bench 使用特定 Redis 实例以支持实时通信非常有用。

set-ssl-certificate

描述: 为站点设置 SSL 证书路径。 用法: bench set-ssl-certificate [site_name] [certificate_path] 说明: 此命令用于为特定站点设置 SSL 证书的路径。SSL 证书是用于加密网站传输的安全协议。通过运行此命令并提供站点名称 [site_name] 和 SSL 证书的路径 [certificate_path]，你可以配置该站点使用特定的 SSL 证书。这对于确保站点安全连接非常重要。

set-ssl-key

描述: 为站点设置 SSL 证书私钥路径。 用法: bench set-ssl-key [site_name] [key_path] 说明: 此命令用于为特定站点设置 SSL 证书的私钥路径。SSL 证书私钥是用于加密网站传输的安全协议。通过运行此命令并提供站点名称 [site_name] 和 SSL 证书私钥的路径 [key_path]，你可以配置该站点使用特定的 SSL 证书私钥。这对于确保站点安全连接非常重要。

set-url-root

描述: 为站点设置 URL 根路径。 用法: bench set-url-root [site_name] [url_root] 说明: 此命令用于为特定站点设置 URL 根路径。URL 根路径是指站点的根 URL 地址。通过运行此命令并提供站点名称 [site_name] 和要设置的 URL 根路径 [url_root]，你可以配置站点使用特定的 URL 根路径。这对于自定义站点的根 URL 地址非常有用。

setup

描述: 用于启用设置 Frappe 环境所需的命令组。 用法: bench setup [COMMAND] [OPTIONS] 说明: setup 是一个命令组，用于设置 Frappe 环境所需的一系列命令。这些命令用于配置和准备 Frappe 环境，包括设置数据库、安装应用程序、配置 SSL 等。你可以运行特定的子命令和选项，以满足特定的配置和环境需求。这对于初始化和配置 Frappe 环境非常有用。

src

描述: 打印 bench 源代码文件夹路径，可以用于切换到 bench 安装存储库。 用法: bench src 说明: 此命令用于打印 bench 的源代码文件夹路径。bench 的源代码包含 bench 的实际实现代码。通过运行此命令，你可以获取 bench 的源代码路径，然后可以使用 cd 命令切换到 bench 安装存储库的目录。这对于开发和定制 bench 环境非常有用。

start

描述: 启动 Frappe 开发环境的进程。 用法: bench start 说明: 此命令用于启动 Frappe 开发环境的相关进程。这些进程包括运行 Frappe 应用程序和其他开发所需的服务。通过运行此命令，你可以开始 Frappe 开发过程，以便测试和开发应用程序。这对于在本地环境中运行 Frappe 应用程序并进行开发非常有用。

switch-to-branch

描述: 将所有应用切换到指定分支，或指定的应用切换到指定分支。 用法: bench switch-to-branch [branch_name] (将 bench 中所有应用切换到指定分支) bench switch-to-branch --all-apps [branch_name] (将 bench 中所有应用切换到指定分支) bench switch-to-branch [app_name] [branch_name] (将指定应用切换到指定分支) 说明: 此命令用于切换 bench 中所有应用或特定应用到指定的 Git 分支。通过运行此命令并提供分支名称 [branch_name]，你可以将 bench 中所有应用切换到该分支。或者，你也可以指定特定应用名称 [app_name] 和分支名称 [branch_name]，将特定应用切换到指定分支。这对于在开发过程中切换分支以获取特定功能或修复非常有用。

switch-to-develop

描述: 将 Frappe 和 ERPNext 切换到 develop 分支。 用法: bench switch-to-develop 说明: 此命令用于将 Frappe 和 ERPNext 应用切换到开发分支 (develop 分支)。通过运行此命令，你可以将 Frappe 和 ERPNext 应用切换到开发分支，以便获取最新的开发版本。这对于开发人员在本地环境中测试最新功能或进行开发非常有用。

update

描述: 在当前 bench 上执行更新操作。 用法: bench update [OPTIONS] 说明: 此命令用于在当前 bench 上执行更新操作。更新操作通常包括备份数据、拉取最新的代码、安装新的依赖、应用程序更新和重新启动 bench 环境。更新 bench 可以确保你的环境处于最新状态，并包括最新的功能和修复。你可以使用不同的选项来控制更新过程。

框架内命令，用法同基础命令 add-system-manager

描述: 向站点添加新的系统管理员。 用法: bench add-system-manager [site_name] [email] 说明: 此命令用于向特定站点添加新的系统管理员。系统管理员拥有对站点的管理权限。通过运行此命令并提供站点名称 [site_name] 和新管理员的邮箱地址 [email]，你可以将该邮箱地址关联到特定站点作为系统管理员。这允许指定的邮箱拥有对站点的管理权限。

add-to-email-queue

描述: 将电子邮件添加到电子邮件队列中。 用法: bench add-to-email-queue [options] [args] 说明: 此命令用于将特定电子邮件添加到电子邮件队列，以便后续发送。可以通过指定一些选项和参数来控制添加到队列的电子邮件的特性。这对于管理电子邮件发送和排队以确保顺序发送非常有用。

add-to-hosts

描述: 将站点添加到系统的 hosts 文件中。 用法: bench add-to-hosts [site_name] 说明: 此命令用于将指定站点添加到系统的 hosts 文件中，以便可以通过自定义域名访问该站点。通过运行此命令并提供站点名称 [site_name]，你可以将该站点的相关信息添加到 hosts 文件中。这对于在本地环境中测试站点以及将自定义域名映射到站点非常有用。

add-user

描述: 向站点添加用户。 用法: bench add-user [site_name] [email] [--first_name] [--last_name] [--password] [--send_welcome_email] 说明: 此命令用于向特定站点添加新用户。通过运行此命令并提供站点名称 [site_name]、新用户的邮箱地址 [email]，以及其他可选参数如名字、姓氏、密码等，你可以向该站点添加新用户。你还可以选择是否发送欢迎邮件给新用户。这对于在站点中管理用户和分配权限非常有用。

backup

描述: 对站点数据进行备份。 用法: bench backup [site_name] 说明: 此命令用于对特定站点的数据进行备份。通过运行此命令并提供站点名称 [site_name]，你可以创建该站点的备份。备份通常包括站点的数据库、文件和其他相关数据，以确保数据的安全性和可恢复性。这对于定期备份站点数据以及在进行重要操作前创建备份非常重要。

browse

描述: 在 web 浏览器中打开站点。 用法: bench browse [site_name] 说明: 此命令用于在系统默认的 web 浏览器中打开特定站点。通过运行此命令并提供站点名称 [site_name]，你可以快速在浏览器中访问该站点。这对于方便地查看站点的界面、测试站点功能等有用。

build

描述: 编译 JavaScript 和 CSS 源文件。 用法: bench build 说明: 此命令用于编译 Frappe 应用程序中的 JavaScript 和 CSS 源文件。编译过程将源文件转换为适用于生产环境的优化版本。编译后的文件可以提高应用程序的性能和加载速度。这对于准备应用程序以进行生产部署非常有用。

build-message-files

描述: 为翻译构建消息文件。 用法: bench build-message-files 说明: 此命令用于为 Frappe 应用程序构建用于翻译的消息文件。翻译文件包含应用程序中用于本地化的文本。通过运行此命令，你可以准备翻译文件，以便进行多语言支持。这对于开发多语言应用程序非常重要。

build-search-index

描述: 构建搜索索引。 用法: bench build-search-index [site_name] 说明: 此命令用于为特定站点构建搜索索引。搜索索引是一种数据结构，用于快速搜索和定位数据。通过运行此命令并提供站点名称 [site_name]，你可以为该站点构建搜索索引，以便在站点上实现高效的搜索功能。这对于优化站点搜索性能非常有用。

bulk-rename

描述: 通过 CSV 文件批量重命名多个记录。 用法: bench bulk-rename [doctype] [csv_file] 说明: 此命令用于通过提供的 CSV 文件批量重命名特定文档类型（[doctype]）的多个记录。CSV 文件应包含记录的标识和新名称。通过运行此命令并提供文档类型 [doctype] 和包含重命名信息的 CSV 文件路径 [csv_file]，你可以批量更改记录的名称。这对于在 Frappe 应用程序中管理大量记录并进行批量操作非常有用。

clear-cache

描述: 清除缓存，文档类型缓存和默认设置。 用法: bench clear-cache [site_name] 说明: 此命令用于清除特定站点的缓存、文档类型缓存和默认设置。缓存是存储临时数据以提高性能的机制。通过运行此命令并提供站点名称 [site_name]，你可以清除该站点的缓存，包括文档类型缓存和默认设置。这对于确保站点数据的准确性和刷新缓存非常有用。

clear-log-table

描述: 如果任何日志类型的表变得过大，则清除日志数据。 用法: bench clear-log-table [site_name] [log_type] 说明: 此命令用于清除特定站点中特定日志类型的数据表。如果任何日志类型的数据表变得过大，可能会影响系统性能。通过运行此命令并提供站点名称 [site_name] 和日志类型 [log_type]，你可以清除该站点中指定日志类型的数据表。这对于管理日志数据并确保系统性能非常有用。

clear-website-cache

描述: 清除网站缓存。 用法: bench clear-website-cache [site_name] 说明: 此命令用于清除特定站点的网站缓存。网站缓存是为了提高网站性能而保存的临时数据。通过运行此命令并提供站点名称 [site_name]，你可以清除该站点的网站缓存。这对于确保网站的最新状态和性能非常有用。

console

描述: 为站点启动 IPython 控制台。 用法: bench console [site_name] 说明: 此命令用于为特定站点启动 IPython 控制台。IPython 是一个强大的交互式 Python 解释器，具有增强的功能和易用性。通过运行此命令并提供站点名称 [site_name]，你可以在该站点的上下文中启动 IPython 控制台，从而可以交互式地执行 Python 代码并测试站点的功能。这对于调试和开发非常有用。

create-patch

描述: 以交互方式创建新的补丁。 用法: bench create-patch 说明: 此命令用于以交互方式创建新的补丁。补丁是用于应用程序的代码修改或更新的一种形式。通过运行此命令，系统将引导你完成创建补丁的过程，包括选择要修改的文件、输入补丁描述等。这使得创建补丁变得更加简单和交互式，适用于开发人员提交和管理代码变更。

create-rq-users

描述: 创建 Redis Queue 用户并将其添加到访问控制列表 (ACL) 中。 用法: bench create-rq-users 说明: 此命令用于创建 Redis Queue (RQ) 用户并将其添加到访问控制列表 (ACL) 中。RQ 是一个用于处理后台任务的 Python 库，通常用于异步处理。通过运行此命令，系统将引导你完成创建 RQ 用户的过程，并将其添加到访问控制列表中，以确保安全访问 RQ。这对于管理 RQ 用户和确保安全非常有用。

data-import

描述: 从 CSV 或 XLSX 文件中批量导入文档。 用法: bench data-import [doctype] [file_path] [--with-std-columns] [--ignore-mandatory] [--ignore-links] 说明: 此命令用于从 CSV 或 XLSX 文件中批量导入指定文档类型（[doctype]）的文档。通过运行此命令并提供文档类型 [doctype] 和文件路径 [file_path]，你可以将指定文档类型的数据从文件中导入到 Frappe 应用程序中。可选参数可以用于控制导入过程，如处理标准列、忽略强制字段和忽略链接。这对于快速导入大量数据非常有用。

db-console

描述: 进入特定站点的数据库控制台。 用法: bench db-console [site_name] 说明: 此命令用于进入特定站点的数据库控制台，允许你在站点的数据库上执行 SQL 查询和命令。通过运行此命令并提供站点名称 [site_name]，你可以打开站点数据库的命令行控制台，以便执行自定义数据库操作。这对于直接在站点数据库上执行查询和管理数据非常有用。

destroy-all-sessions

描述: 清除所有用户的会话（使其注销）。 用法: bench destroy-all-sessions [site_name] 说明: 此命令用于清除特定站点的所有用户的会话，即使用户当前已登录也会将其注销。通过运行此命令并提供站点名称 [site_name]，你可以强制清除站点上所有用户的会话。这对于管理用户会话和确保安全性非常有用。

disable-scheduler

描述: 禁用调度器。 用法: bench disable-scheduler [site_name] 说明: 此命令用于禁用特定站点的调度器，停止后台定期任务的执行。通过运行此命令并提供站点名称 [site_name]，你可以禁用该站点的调度器，暂停所有自动执行的后台任务。这对于暂时停止自动任务执行非常有用，如在维护期间。

disable-user

描述: 禁用用户。 用法: bench disable-user [user_email] 说明: 此命令用于禁用特定邮箱地址的用户。通过运行此命令并提供用户的邮箱地址 [user_email]，你可以禁用该用户，即禁止其登录和访问系统。这对于暂时禁用用户或在用户不再需要访问系统时禁用其账户非常有用。

doctor

描述: 获取有关后台工作进程的诊断信息。 用法: bench doctor [site_name] 说明: 此命令用于获取特定站点后台工作进程的诊断信息，包括状态、运行情况等。通过运行此命令并提供站点名称 [site_name]，你可以获取有关后台工作进程的详细信息，有助于诊断和解决与后台任务相关的问题。这对于监控后台任务的运行状态和进行故障排除非常有用。

drop-site

描述: 参考特定站点的删除操作。 用法: bench drop-site [site_name] 说明: 此命令用于参考特定站点的删除操作，即删除站点及其相关数据。通过运行此命令并提供站点名称 [site_name]，你可以删除指定站点。这会清除该站点的所有数据，包括数据库、文件等，慎用该命令以避免数据丢失。

enable-scheduler

描述: 启用调度器。 用法: bench enable-scheduler [site_name] 说明: 此命令用于启用特定站点的调度器，允许后台定期任务的执行。通过运行此命令并提供站点名称 [site_name]，你可以启用该站点的调度器，使其可以自动执行后台任务。这对于重新启动或恢复自动任务执行非常有用。

execute

描述: 执行一个函数。 用法: bench execute [site_name] [module].[function] [args] 说明: 此命令用于执行特定站点中的一个函数。通过运行此命令并提供站点名称 [site_name]、要执行的模块和函数 [module].[function]，以及可能的参数 [args]，你可以在站点上执行指定的函数。这对于在站点上执行自定义操作或调用特定函数非常有用。

export-csv

描述: 导出带有数据的数据导入模板为 CSV 文件。 用法: bench export-csv [doctype] [file_path] [--all] 说明: 此命令用于导出特定文档类型（[doctype]）的数据导入模板为 CSV 文件，并可以选择导出所有数据。通过运行此命令并提供文档类型 [doctype] 和文件路径 [file_path]，你可以将文档类型的数据导入模板以 CSV 格式导出到指定文件中。可选参数 --all 可用于导出所有数据而不仅仅是模板。这对于备份和共享数据导入模板及其数据非常有用。

export-doc

描述: 将单个文档导出为 CSV 文件。 用法: bench export-doc [doctype] [docname] [file_path] 说明: 此命令用于将特定文档类型（[doctype]）中的单个文档（由 [docname] 标识）导出为 CSV 文件。通过运行此命令并提供文档类型 [doctype]、文档名称 [docname] 和文件路径 [file_path]，你可以将指定文档导出为 CSV 格式的文件。这对于备份特定文档或将其数据导出到 CSV 文件中非常有用。

export-fixtures

描述: 导出固定数据。 用法: bench export-fixtures [app_name] [file_path] 说明: 此命令用于导出特定应用程序（[app_name]）的固定数据为 JSON 文件。通过运行此命令并提供应用程序名称 [app_name] 和文件路径 [file_path]，你可以将应用程序的固定数据导出为 JSON 格式的文件，以便备份或在其他系统中导入。这对于数据备份和迁移非常有用。

export-json

描述: 将文档列表（doclist）导出为 JSON 文件到指定路径。 用法: bench export-json [doctype] [file_path] [--all] 说明: 此命令用于将指定文档类型（[doctype]）的文档列表导出为 JSON 文件，并可以选择导出所有数据。通过运行此命令并提供文档类型 [doctype] 和文件路径 [file_path]，你可以将文档列表以 JSON 格式导出到指定文件中。可选参数 --all 可用于导出所有数据而不仅仅是模板。这对于备份和共享文档列表及其数据非常有用。

get-untranslated

描述: 获取特定语言的未翻译字符串。 用法: bench get-untranslated [language_code] [output_file] 说明: 此命令用于获取特定语言（由 [language_code] 标识）的未翻译字符串，并将其输出到指定文件 [output_file]。通过运行此命令并提供语言代码 [language_code] 和输出文件路径 [output_file]，你可以获取该语言中未翻译的字符串，有助于进行翻译工作。这对于管理多语言应用程序的翻译非常有用。

import-csv

描述: ** [不推荐使用] ** 用于导入 CSV 文件中的数据。 用法: bench import-csv [file_path] 说明: 此命令用于导入 CSV 文件中的数据。然而，该命令已经不推荐使用。推荐使用更现代的导入方法来导入数据，如使用 bench data-import 命令。因此，不建议使用 import-csv 命令进行数据导入，而应使用推荐的替代方法。

import-doc

描述: 导入（插入/更新）文档列表（doclist）数据。 用法: bench import-doc [options] [file_path] 说明: import-doc 命令用于将文档列表（doclist）数据导入到 ERPNext 或 Frappe 应用中。doclist 是包含要导入的文档数据的 Python 列表或 JSON 文件。 通过指定选项和提供文件路径，你可以使用 import-doc 命令将先前导出的文档列表或外部数据源中的文档数据导入到 ERPNext 或 Frappe 应用中。导入操作可以插入新的文档或更新现有的文档。 该命令在批量加载数据、数据迁移或在不同环境中同步数据等场景中非常有用。通过使用 import-doc 命令，开发人员可以方便地管理和操作文档数据。 请注意，导入操作的成功与否取决于数据的正确性和应用程序的配置。在执行导入操作之前，请确保提供的文档数据与应用的数据模型和字段匹配。

install-app

描述: 将新应用程序安装到站点上，支持多个应用同时安装。 用法: bench install-app [options] [app_name] 说明: install-app 命令用于将新的应用程序安装到 ERPNext 或 Frappe 站点上。它支持同时安装多个应用程序。 通过指定选项和提供应用程序名称，你可以使用 install-app 命令将一个或多个应用程序安装到指定的站点上。安装应用程序后，它们将被添加到站点的应用程序列表中，并可在站点中使用。 install-app 命令可以在应用程序开发、扩展和定制方面非常有用。它允许开发人员将新的功能或插件应用程序添加到 ERPNext 或 Frappe 站点上，以满足业务需求和定制要求。 在执行 install-app 命令之前，请确保已正确配置和准备要安装的应用程序。此外，应确保站点已启动且处于可用状态。

list-apps

描述: 列出站点中的应用程序。 用法: bench list-apps [options] 说明: list-apps 命令用于列出指定站点中已安装的应用程序。 通过执行 list-apps 命令，你可以查看指定站点上已经安装的应用程序列表。这些应用程序是 ERPNext 或 Frappe 平台提供的各种功能和插件，用于满足不同的业务需求和定制要求。 list-apps 命令对于了解站点的应用程序配置和状态非常有用。它可以帮助你查看某个站点安装了哪些应用程序，以及它们的版本和状态信息。这对于管理和维护站点以及处理应用程序的依赖关系都有帮助。 请注意，要使用 list-apps 命令，你需要指定所需的选项或参数。通常，指定站点名称是必要的，以便列出特定站点中的应用程序。

make-app

描述: 创建一个应用程序的样板文件。 用法: bench make-app [app_name] 说明: make-app 命令用于创建一个应用程序的样板文件，以便快速开始开发自定义应用程序。 通过执行 make-app 命令并提供应用程序名称，你可以生成一个应用程序的基本文件结构和模板。这些文件包括应用程序的目录结构、初始化文件以及示例代码和配置文件等。 make-app 命令对于开发自定义的 ERPNext 或 Frappe 应用程序非常有用。它提供了一个快速的起点，让你可以在此基础上构建和扩展你的应用程序。 在执行 make-app 命令之前，请确保已正确配置和准备开发环境。应用程序名称应遵循特定的命名规范，并且不能与现有的应用程序冲突。

mariadb

描述: 进入指定站点的 MariaDB 控制台。 用法: bench mariadb [site_name] 说明: mariadb 命令用于进入指定站点的 MariaDB 控制台，以便执行数据库操作和查询。 通过执行 mariadb 命令并提供站点名称，你可以连接到相应站点的 MariaDB 数据库，以便直接在数据库中执行 SQL 查询和操作。这为管理员和开发人员提供了一个方便的方式来管理站点的数据库。 进入 MariaDB 控制台后，你可以执行各种数据库相关的操作，例如创建、修改和删除表，插入、更新和删除数据，以及执行复杂的查询和优化等。 请注意，要使用 mariadb 命令，你需要正确配置和准备站点的数据库连接信息。此外，需要确保有足够的权限来访问和操作数据库。

migrate

描述: 执行补丁，同步模式和重建内容索引。 用法: bench migrate [options] 说明: migrate 命令用于执行补丁（patches），同步模式（sync schema）和重建内容索引（rebuild indexes）等操作。 通过执行 migrate 命令，你可以对 ERPNext 或 Frappe 应用进行数据库迁移和升级。这包括应用新的补丁、同步数据库模式的更改以及重建内容索引以提高性能。 在执行 migrate 命令时，可以选择提供特定的选项，以指定要执行的操作。这可能包括提供补丁的版本号、指定要同步的应用程序或模块，以及选择是否重新建立索引等。 migrate 命令在应用程序的维护和升级过程中非常有用。它可以确保数据库的结构与代码的变化保持一致，并且在必要时重建索引以提高查询性能。 请注意，要使用 migrate 命令，需要具备相应的权限和正确的配置。在执行命令之前，请确保已备份重要的数据并进行必要的测试。

migrate-to

描述: 将站点迁移到指定的提供商。 用法: bench migrate-to [options] [site_name] [provider] 说明: migrate-to 命令用于将指定的站点迁移到指定的提供商。 通过执行 migrate-to 命令并提供站点名称和目标提供商，你可以将正在运行的 ERPNext 或 Frappe 站点迁移到另一个提供商。迁移过程将包括数据库和文件的转移以及相关的配置更改。 在执行 migrate-to 命令时，可能需要提供特定的选项，以提供所需的迁移配置。这可能涉及到目标提供商的连接信息、访问凭据等。请参考相关的文档或迁移工具的说明以获取更详细的指导。 migrate-to 命令对于将 ERPNext 或 Frappe 站点从一个主机迁移到另一个主机非常有用。它提供了一个统一的方式来管理站点的迁移过程，确保数据和配置的安全转移。 请注意，在执行 migrate-to 命令之前，请务必备份重要的数据，并确保目标提供商的准备和配置已完成。

new-language

描述: 为给定应用程序创建 lang-code.csv 文件。 用法: bench new-language [options] [app_name] 说明: new-language 命令用于为给定的应用程序创建 lang-code.csv 文件。 通过执行 new-language 命令并提供应用程序名称，你可以在指定的应用程序中创建 lang-code.csv 文件。lang-code.csv 文件用于配置应用程序的多语言支持，包含各种语言和对应的语言标识码。 在创建 lang-code.csv 文件之前，请确保已正确配置和准备应用程序的开发环境。此外，请确保已了解应用程序中所需的语言和相应的语言标识码。 创建 lang-code.csv 文件后，你可以在其中添加或编辑任何需要支持的语言及其对应的标识码。这将为应用程序提供多语言支持，在用户界面和本地化文本方面提供更多的灵活性。

new-site

描述: 创建一个新的站点。 用法: bench new-site [options] [site_name] 说明: new-site 命令用于创建一个新的 ERPNext 或 Frappe 站点。 通过执行 new-site 命令并提供站点名称，你可以在 ERPNext 或 Frappe 平台上创建一个全新的站点。站点是一个独立的实例，包含了数据库、文件和相应的配置，用于管理特定的业务应用程序。 在创建新站点之前，请确保已正确配置和准备环境，并具有相应的权限。创建站点可能需要提供一些选项和配置信息，例如数据库类型、管理员密码、要使用的应用程序等。 创建新站点后，你将能够通过该站点的 URL 访问到 ERPNext 或 Frappe 应用程序，并开始配置和使用该站点来满足特定的业务需求。 请注意，在创建新站点之前，请确保仔细阅读相关的文档和指南，以了解所需的配置和注意事项。 请注意，在创建 lang-code.csv 文件之前，建议先了解应用程序开发中的多语言支持和国际化的相关概念。

partial-restore

描述: 参考部分恢复的相关文档。 使用: 请参考相关文档。 说明: "partial-restore" 是用于部分恢复 ERPNext 或 Frappe 应用的过程，通常用于恢复特定的模块、数据或配置。 由于 "partial-restore" 是一个特定于应用程序的操作，并且与 ERPNext 或 Frappe 平台的功能和操作直接相关，因此我无法为你提供关于 "partial-restore" 的具体解释和用法说明。建议你参考相关的 ERPNext 或 Frappe 文档以获取详细信息和操作指南。 根据你的需求和情况，可能需要了解如何选择要恢复的特定模块、数据或配置，并以正确的方式执行部分恢复。ERPNext 和 Frappe 文档通常提供了有关如何执行部分恢复的指南和说明。 请记住，在对数据进行恢复之前，请确保你已经进行了必要的备份，并在执行恢复操作之前仔细阅读相关的文档和指南。

postgres

描述: 进入指定站点的 PostgreSQL 控制台。 用法: bench postgres [site_name] 说明: postgres 命令用于进入指定站点的 PostgreSQL 控制台，以便执行数据库操作和查询。 通过执行 postgres 命令并提供站点名称，你可以连接到相应站点的 PostgreSQL 数据库，以便直接在数据库中执行 SQL 查询和操作。这为管理员和开发人员提供了一个方便的方式来管理站点的数据库。 进入 PostgreSQL 控制台后，你可以执行各种数据库相关的操作，例如创建、修改和删除表，插入、更新和删除数据，以及执行复杂的查询和优化等。

publish-realtime

描述: 从 bench 发布实时事件。 用法: bench publish-realtime [event] [data] [options] 说明: publish-realtime 命令用于从 bench 发布实时事件。 通过执行 publish-realtime 命令并提供事件名称、数据和选项，你可以发布实时事件到 ERPNext 或 Frappe 应用程序。实时事件可以让应用程序的不同部分之间进行实时通信和数据传输。 发布实时事件可以用于触发特定的业务逻辑、通知用户或更新应用程序界面等。你可以根据实际需求定义自己的实时事件，以便实现所需的功能和交互。 在执行 publish-realtime 命令时，你需要提供事件名称和相关的数据。选项可以根据需要进行配置，以满足特定的发布要求。 请记住，在发布实时事件之前，请确保已经正确配置和准备你的应用程序。此外，了解实时事件的使用和订阅机制对于确保数据的正确传递和处理是很重要的。 请注意，要使用 postgres 命令，你需要具备相应的权限和正确的配置。在执行命令之前，请确保已备份重要的数据，并进行必要的测试。

purge-jobs

描述: 清除任何挂起的周期性任务，如果事件不存在则清除所有任务。 用法: bench purge-jobs [options] [event] 说明: purge-jobs 命令用于清除任何挂起的周期性任务，如果指定的事件存在，则仅清除该事件的任务。 通过执行 purge-jobs 命令并提供选项和事件名称，你可以清除任何挂起的周期性任务。如果指定了事件名称，则只清除该事件的任务。如果未指定事件名称，则清除所有挂起的任务。 周期性任务是 ERPNext 或 Frappe 应用中基于计划的任务，用于自动执行定时的操作。使用 purge-jobs 命令可以清除挂起的任务，以防止它们继续执行或积累。 在执行 purge-jobs 命令之前，请确保了解作业调度系统和周期性任务的工作原理。请谨慎使用此命令，并确保正确配置和准备你的应用程序。

ready-for-migration: 描述: 参考准备迁移的相关文档。 使用: 请参考相关文档。 说明: "ready-for-migration" 是一个特定于应用程序迁移的过程，用于准备迁移前的必要步骤和检查。 由于 "ready-for-migration" 是与应用程序迁移相关的操作，并且与 ERPNext 或 Frappe 平台的功能和操作有直接关联，因此我无法为你提供关于 "ready-for-migration" 的具体解释和用法说明。建议你参考相关的 ERPNext 或 Frappe 文档以获取详细信息和操作指南。 在准备迁移之前，可能需要进行一些必要的步骤和检查，以确保准备恰当且迁移顺利进行。这可能包括备份数据、更新应用程序和依赖项、处理数据库迁移和升级、设置新环境等。 请仔细阅读相关的文档和指南，以确保你理解迁移过程中的步骤和要求。准备迁移是一个关键的阶段，影响到迁移的成功和应用程序的稳定性。

rebuild-global-search: 描述: 在当前站点中设置帮助表（称为 Help Table）并重建全局搜索索引。 用法: bench rebuild-global-search [options] 说明: rebuild-global-search 命令用于在当前站点中设置帮助表（Help Table）并重建全局搜索索引。 通过执行 rebuild-global-search 命令，你可以在当前站点中设置帮助表，并重新构建全局搜索索引。帮助表是用于存储文档和帮助相关内容的数据库表，以支持全局搜索功能。 在执行 rebuild-global-search 命令时，你可以选择提供特定的选项，以满足你的要求。这可能包括指定帮助表的名称或启用其他相关的配置。 重建全局搜索索引将对站点的搜索功能进行更新和优化，确保文档和帮助内容能够被准确地检索和呈现给用户。这对于提供更好的用户体验和支持系统非常有帮助。 在执行 rebuild-global-search 命令之前，请确保已正确配置和准备站点，并且了解相关的帮助表设置和全局搜索索引的重建过程。

reinstall

描述: 重新安装站点。 用法: bench reinstall [site_name] [options] 说明: reinstall 命令用于重新安装指定的站点。 通过执行 reinstall 命令并提供站点名称和选项，你可以重新安装指定的 ERPNext 或 Frappe 站点。重新安装过程将清除现有的站点数据和配置，并重新初始化站点以开始全新的安装过程。 在执行 reinstall 命令时，可能需要提供特定的选项来配置重新安装的行为。这可能包括指定要使用的应用程序、数据库类型、管理员密码等。 重新安装站点对于重置站点或纠正安装问题非常有用。它提供了一种快速而简便的方法来重新开始站点的安装过程，并确保站点的配置和数据的一致性。 请注意，重新安装站点将删除现有的站点数据和配置，因此在执行重新安装之前，请确保有备份数据的副本，并谨慎操作。

reload-doc

描述: 重新加载文档类型的模式（schema）。 用法: bench reload-doc [doctype] [options] 说明: reload-doc 命令用于重新加载指定文档类型的模式（schema）。 通过执行 reload-doc 命令并提供文档类型名称和选项，你可以重新加载指定文档类型的模式。重新加载模式将会应用最新的更改和定义，更新文档类型的字段、布局和相关配置。 重新加载文档类型的模式对于在开发过程中对文档类型进行修改和扩展非常有用。当你修改文档类型的字段、栏目、规则等时，执行 reload-doc 命令可以使更新的定义生效。 在执行 reload-doc 命令之前，请确保已正确配置和准备开发环境，并且了解文档类型定义和模式的基本概念。此外，请确保谨慎操作，并在对生产环境进行更改之前进行充分的测试和验证。

reload-doctype

描述: 重新加载文档类型的模式（schema）。 用法: bench reload-doctype [doctype] [options] 说明: reload-doctype 命令用于重新加载指定文档类型的模式（schema）。 通过执行 reload-doctype 命令并提供文档类型名称和选项，你可以重新加载指定文档类型的模式。重新加载模式将应用最新的更改和定义，更新文档类型的字段、布局和相关配置。 重新加载文档类型的模式对于在开发过程中对文档类型进行修改和扩展非常有用。当你修改文档类型的字段、栏目、规则等时，执行 reload-doctype 命令可以使更新的定义生效。 在执行 reload-doctype 命令之前，请确保已正确配置和准备开发环境，并了解文档类型定义和模式的基本概念。此外，请谨慎操作，并在对生产环境进行更改之前进行充分的测试和验证。

remove-from-installed-apps: 描述: 从站点的已安装应用列表中移除应用程序。 用法: bench remove-from-installed-apps [options] [app_name] [site_name] 说明: remove-from-installed-apps 命令用于从站点的已安装应用列表中移除指定的应用程序。 通过执行 remove-from-installed-apps 命令并提供应用程序名称和站点名称，你可以将指定的应用程序从站点的已安装应用列表中移除。这将从站点中卸载该应用程序，并且在站点的配置中不再加载该应用程序。 移除已安装的应用程序可以用于对站点的应用程序进行管理和配置。你可以通过移除不再需要的应用程序来清理站点并减少不必要的资源消耗。 在执行 remove-from-installed-apps 命令之前，请确保了解删除应用程序可能带来的后果，并确保对站点进行备份，以防需要恢复。请谨慎操作，并遵循相关的指南和最佳实践。

request

描述: 以管理员身份运行请求。 用法: bench request [method] [url] [data] [options] 说明: request 命令用于以管理员身份运行请求。 通过执行 request 命令并提供请求方法、URL、数据和选项，你可以以管理员身份运行请求，并发送 HTTP 请求到指定的 URL。 使用 request 命令可以模拟发送请求，并以管理员权限执行操作。这对于测试 API 端点、调试代码或执行需要管理员权限的操作非常有用。 在执行 request 命令时，你需要提供请求的方法（GET、POST、PUT等）、URL 和可选的数据（如果需要）。选项可以根据需要进行配置，以满足特定的请求需求。 请注意，在运行请求之前，请确保了解请求的目的和需求，并理解所执行操作的影响。谨慎使用 request 命令，并确保对站点的更改和操作进行充分测试和验证。

reset-perms: 描述: 重置权限。 用法: bench reset-perms [site_name] [options] 说明: reset-perms 命令用于重置指定站点的权限设置。 通过执行 reset-perms 命令并提供站点名称和选项，你可以重置指定站点的权限设置。这将重新设置站点文件和目录的权限，并确保它们与默认设置一致。 重置权限对于修复站点中的权限问题、恢复默认权限设置或解决访问问题非常有用。它可以将站点文件和目录的权限还原为理想的状态，并确保正确的权限配置。 在执行 reset-perms 命令之前，请确保了解权限设置和操作的影响。谨慎操作并确保提供正确的站点名称。请注意，重置权限操作将更改文件和目录的权限，因此在执行之前请确保有必要的备份和谨慎操作。

restore: 描述: 恢复站点数据。 用法: bench restore [options] [site_name] [backup_file] 说明: restore 命令用于从备份文件中恢复站点数据。 通过执行 restore 命令并提供选项、站点名称和备份文件路径，你可以从备份文件中恢复指定站点的数据。这将还原站点数据库和文件系统的备份，以使站点恢复到先前的状态。 在执行 restore 命令时，你可以选择提供特定的选项来自定义恢复过程。选项可以包括恢复数据库、文件系统或同时恢复两者，以及选择备份文件的类型和位置等。 恢复站点数据对于从备份中恢复站点、迁移站点或纠正数据损坏等情况非常有用。在执行恢复操作之前，请确保备份文件的可用性和完整性，并了解恢复过程的注意事项和要求。 请注意，恢复操作将覆盖当前站点的数据和文件，请谨慎操作，并确保在执行之前进行必要的备份和测试。

run-parallel-tests: 描述: 运行并行测试。 用法: bench run-parallel-tests [options] 说明: run-parallel-tests 命令用于运行并行测试。 通过执行 run-parallel-tests 命令并提供选项，你可以在 ERPNext 或 Frappe 应用中运行并行测试。并行测试允许同时运行多个测试用例，以加快测试的执行速度。 并行测试对于加快测试套件的执行和发现潜在问题非常有用。它能够利用多个处理器和线程，并同时执行多个测试用例，从而提高整体的测试效率。 在执行 run-parallel-tests 命令时，你可以选择提供特定的选项以配置并行测试的行为。这可能包括指定要运行的测试套件、线程数量、超时设置等。 请注意，在执行并行测试之前，请确保已正确配置和准备测试环境，并了解并行测试的限制和使用方式。此外，测试用例应该在并发执行时是独立的，并且不会造成冲突或竞争条件。

run-patch

描述: 运行补丁。 用法: bench run-patch [patch_name] [site_name] [options] 说明: run-patch 命令用于运行指定的补丁。 通过执行 run-patch 命令并提供补丁名称、站点名称和选项，你可以运行指定的补丁。补丁是在 ERPNext 或 Frappe 应用中应用特定的变更或修复的脚本。 运行补丁可以应用新的功能、修复漏洞或处理数据问题等。补丁脚本将在指定的站点上执行必要的操作，以确保补丁的变更被正确应用并生效。 在执行 run-patch 命令时，你应该提供要运行的补丁名称和相应的站点名称。根据需要，可以配置选项以满足特定的补丁要求，例如提供管理员密码、指定数据文件等。 请注意，在运行补丁之前，请确保了解补丁的目的和改变，以及可能对数据和配置产生的影响。谨慎运行补丁并进行适当的测试和验证。

run-tests

描述: 运行测试。 用法: bench run-tests [options] 说明: run-tests 命令用于运行 ERPNext 或 Frappe 应用的测试。 通过执行 run-tests 命令并提供相应的选项，你可以运行应用程序的测试用例。测试用例是编写的代码片段，用于验证应用程序的功能和逻辑是否按预期工作。 运行测试是确保应用程序质量和稳定性的重要步骤。它会自动运行测试用例并生成报告，指示哪些测试通过、失败或有错误。 在执行 run-tests 命令时，你可以选择提供特定的选项以配置测试的行为。这可以包括指定要运行的测试模块、覆盖率设置、测试报告输出路径等。 请注意，在运行测试之前，请确保已正确配置和准备测试环境，并了解测试用例和代码覆盖率的基本概念。同时，对于需要测试的特定功能或模块，应编写相应的测试用例。

run-ui-tests

描述: 运行用户界面(UI)测试。 用法: bench run-ui-tests [options] 说明: run-ui-tests 命令用于运行 ERPNext 或 Frappe 应用的用户界面(UI)测试。 通过执行 run-ui-tests 命令并提供相应的选项，你可以运行应用程序的用户界面(UI)测试。UI测试是用于验证应用程序用户界面的交互、功能和可靠性的测试。 运行UI测试是确保应用程序的用户界面工作正常的关键步骤。它模拟用户在应用程序中的交互，并自动执行各种操作、点击按钮、填写表单等，以验证预期的行为是否正确。 在执行 run-ui-tests 命令时，你可以选择提供特定的选项以定制测试的行为。这可能包括指定要运行的测试套件、浏览器类型、测试报告输出路径等。 请注意，在运行UI测试之前，请确保已正确配置和准备UI测试环境，并了解UI测试框架和工具的使用。为需要测试的特定功能和交互编写相应的UI测试用例，并确保正确和可靠的测试结果。

schedule

描述: 调度任务。 用法: bench schedule [options] 说明: schedule 命令用于对 ERPNext 或 Frappe 应用中的定时任务进行调度。 通过执行 schedule 命令并提供相应的选项，你可以调度应用程序的定时任务。定时任务是预定的任务或操作，根据指定的时间间隔或计划运行。 调度定时任务对于自动执行重复性的操作、批处理任务或计划性的操作非常有用。它可以根据预定的时间计划自动运行任务，以确保任务按计划执行。 在执行 schedule 命令时，你可以选择提供特定的选项以配置调度行为。这可能包括指定要调度的任务、调度的时间间隔、调度规则等。 请注意，在调度任务之前，请确保已正确配置和准备应用程序，了解定时任务的要求和行为。确保提供合适的选项和配置，以满足你的调度需求，并验证任务按预期计划运行。

scheduler

描述: 调度器（Scheduler）管理命令。 用法: bench scheduler [command] [options] 说明: scheduler 命令用于管理 ERPNext 或 Frappe 应用程序中的调度器。 通过执行 scheduler 命令并提供相应的子命令和选项，你可以管理调度器的行为和操作。调度器是负责管理和执行预定的任务和操作的组件。 调度器可用于触发定时任务、队列任务和后台作业的执行。它管理任务的调度、执行和监控，并确保它们按计划和预期执行。 scheduler 命令的子命令包括启动调度器（start）、停止调度器（stop）、重新启动调度器（restart）、显示调度器状态（status）等。 请注意，在执行 scheduler 命令之前，请确保已正确配置和准备调度器环境，并了解各个子命令的用途和行为。根据需求选择相应的子命令和选项，并根据需要监控和管理调度器的运行。

serve

描述: 启动本地开发服务器。 用法: bench serve [options] 说明: serve 命令用于启动本地开发服务器，以运行 ERPNext 或 Frappe 应用程序。 通过执行 serve 命令并提供相应的选项，你可以启动本地开发服务器，以便在开发环境中运行应用程序。服务命令将启动一个本地Web服务器，提供应用程序的访问接口和界面。 启动本地开发服务器对于开发和调试应用程序非常有用。它允许你在本地进行开发和测试，查看应用程序的更改并与其进行交互。 在执行 serve 命令时，你可以选择提供特定的选项以配置服务器的行为。这可能包括指定要监听的主机和端口、启用调试模式、设置文件夹路径等。 请注意，在启动本地服务器之前，请确保已正确配置开发环境，并了解所需的选项和配置。谨慎启动服务器，并确保进行必要的测试和验证，以确保应用程序能够正常运行。

set-admin-password

描述: 设置管理员密码。 用法: bench set-admin-password [password] 说明: set-admin-password 命令用于设置管理员密码。 通过执行 set-admin-password 命令并提供新的管理员密码，你可以设置 ERPNext 或 Frappe 应用程序的管理员密码。管理员密码用于管理和访问应用程序的管理员权限。 设置管理员密码是确保应用程序安全性的重要步骤。管理员密码应该是强密码，并且仅应提供给授权的管理员。 在执行 set-admin-password 命令时，请确保提供一个安全且易于记住的密码。建议使用包含大写字母、小写字母、数字和特殊字符的复杂密码，并妥善保管。

set-config

描述: 设置配置值。 用法: bench set-config [config_key] [config_value] [--site site_name] [--force] 说明: set-config 命令用于设置指定配置键的值。 通过执行 set-config 命令并提供配置键和对应的配置值，你可以设置 ERPNext 或 Frappe 应用程序中的配置项的值。 设置配置值可以修改应用程序的配置，以满足特定需求和定制要求。配置值可以是字符串、整数或布尔值等不同类型的数据。 在执行 set-config 命令时，你需要提供要设置的配置键及其对应的值。你还可以使用选项来指定要在特定站点上设置配置值（--site site_name）或强制覆盖现有配置值（--force）。 请注意，在设置配置值之前，请确保了解所需配置项的名称和值的要求。谨慎设置配置值，并在设置之前备份重要的配置文件或数据。确保设置的配置值能够正常运行，并验证所做的更改是否产生预期的效果。

set-last-active-for-user

描述: 设置用户的最后活动时间。 用法: bench set-last-active-for-user [user_email] [--site site_name] 说明: set-last-active-for-user 命令用于设置用户的最后活动时间。 通过执行 set-last-active-for-user 命令并提供用户的电子邮件地址，你可以设置指定用户的最后活动时间。最后活动时间记录了用户最近一次登录或进行活动的时间戳。 设置用户的最后活动时间可以用于用户管理和安全审计的目的。它可以帮助跟踪用户的活动，了解用户最近一次与应用程序交互的时间。 在执行 set-last-active-for-user 命令时，你需要提供用户的电子邮件地址来指定要设置最后活动时间的用户。你还可以使用选项来指定在特定站点上设置用户的最后活动时间。 请注意，在设置用户的最后活动时间之前，请确保有合法的用户电子邮件地址，并选择适当的站点进行操作。谨慎设置最后活动时间，并确保该时间反映用户的实际活动情况。

set-maintenance-mode

描述: 设置维护模式状态。 用法: bench set-maintenance-mode [enabled|disabled] [--site site_name] 说明: set-maintenance-mode 命令用于设置维护模式的状态。 通过执行 set-maintenance-mode 命令并提供状态参数（enabled 或 disabled），你可以设置 ERPNext 或 Frappe 应用程序的维护模式状态。 维护模式状态用于控制应用程序是否处于维护模式下。在维护模式下，应用程序会显示一个维护页面，暂停正常使用，并提示用户进行维护和升级。 在执行 set-maintenance-mode 命令时，你需要提供状态参数来指定是启用维护模式（enabled）还是禁用维护模式（disabled）。你还可以使用选项来指定在特定站点上设置维护模式状态。 请注意，在设置维护模式状态之前，请确保理解维护模式的目的和影响，并根据需要进行充分的测试和验证。谨慎选择启用或禁用维护模式，并确保通知用户关于维护模式的信息。

set-password

描述: 设置用户密码。 用法: bench set-password [user_email] [--password password] [--site site_name] 说明: set-password 命令用于设置用户的密码。 通过执行 set-password 命令并提供用户的电子邮件地址，你可以设置指定用户的密码。密码可用于用户身份验证和访问应用程序。 设置用户密码是确保用户账户的安全和保护的关键步骤。密码应该是强密码，结合大小写字母、数字和特殊字符，以增加密码强度。 在执行 set-password 命令时，你需要提供用户的电子邮件地址来指定要设置密码的用户。你可以使用选项来指定要设置的密码（--password password）以及要在哪个站点上设置密码（--site site_name）。 请注意，在设置用户密码之前，请确保授权并遵循适当的用户密码策略。保护用户密码的机密性，并确保用户密码不被泄露或共享。推荐定期更改密码，并谨慎设置和管理用户的密码。

show-config

描述: 显示配置值。 用法: bench show-config [options] 说明: show-config 命令用于显示 ERPNext 或 Frappe 应用程序的配置值。 通过执行 show-config 命令并提供相应的选项，你可以查看应用程序的配置值。配置值是应用程序的各种设置和选项，用于控制应用程序的行为和功能。 查看配置值对于了解当前应用程序的配置非常有用。它可以帮助你检查和确认应用程序的配置，以及验证是否按预期设置。 在执行 show-config 命令时，你可以选择提供特定的选项以满足你的需求。例如，你可以指定要显示的特定配置项，或在确定站点上查看配置值。 请注意，在查看配置值时，确保有适当的权限来访问和查看配置信息。请谨慎处理敏感的配置值，并确保遵循安全和保密的最佳实践。

show-pending-jobs

描述: 显示待处理的作业。 用法: bench show-pending-jobs [options] [--queue queue] 说明: show-pending-jobs 命令用于显示待处理的作业。 通过执行 show-pending-jobs 命令并提供相应的选项，你可以查看待处理的作业列表。作业是由 ERPNext 或 Frappe 应用程序放入队列中等待处理的任务或操作。 显示待处理的作业对于了解当前队列中的作业数量和内容非常有用。它可以帮助你监控和管理作业的状态，以确保它们得到适时处理。 在执行 show-pending-jobs 命令时，你可以选择提供特定的选项以满足你的需求。例如，你可以指定要显示的特定队列（--queue queue）或其他相关的选项。 注意，在显示待处理的作业时，确保有适当的权限来访问和查看作业信息。了解作业的类型和目的，并牢记作业的执行可能对应用程序产生影响。

start-recording

描述: 开始记录（录制）操作。 用法: bench start-recording [filename] 说明: 此命令用于开始记录（录制）用户在 Frappe 应用程序中执行的操作。你需要提供记录的文件名 [filename]，记录将保存到该文件中。通过运行此命令，系统会开始记录用户的操作，以便后续回放或分析。这对于记录操作流程和进行测试非常有用。

stop-recording

描述: 停止记录（录制）操作。 用法: bench stop-recording 说明: 此命令用于停止记录（录制）用户在 Frappe 应用程序中执行的操作。通过运行此命令，系统会停止记录用户的操作。一旦停止记录，你可以保存记录的操作流程以备将来回放或分析。这对于记录操作流程和进行测试非常有用。

transform-database

描述: 更改数据库的内部设置，改变数据库的结构。 用法: bench transform-database [arguments] 说明: 此命令用于更改数据库的内部设置，改变数据库的结构，例如表结构等。该命令可能需要提供一些参数以指定要进行的特定转换或变化。注意，这是一个通用性的命令，具体的用法和参数会根据具体情况而定，因此需要查看具体文档或提供具体的场景以获取更准确的用法信息。这对于在 Frappe 应用程序中执行数据库结构变更非常有用。

trim-database

描述: 删除已删除文档类型的数据库表。 用法: bench trim-database [选项] 说明: trim-database 命令用于删除已删除的文档类型的数据库表。这些表是不再需要的，通常是因为文档类型已被删除，但相应的数据库表仍然存在。通过运行此命令，可以清理数据库，删除不再需要的表，以释放资源并保持数据库整洁。 请注意，在运行此命令时，确保备份数据库以避免意外数据丢失。删除数据库表是一个敏感操作，应谨慎执行，并确保在安全的环境中进行。

trim-tables

描述: 删除已删除文档类型的数据库表。 用法: bench trim-tables [选项] 说明: trim-tables 命令用于删除已删除的文档类型的数据库表。这些表是不再需要的，通常是因为文档类型已被删除，但相应的数据库表仍然存在。通过运行此命令，可以清理数据库，删除不再需要的表，以释放资源并保持数据库整洁。 请注意，在运行此命令时，确保备份数据库以避免意外数据丢失。删除数据库表是一个敏感操作，应谨慎执行，并确保在安全的环境中进行。

uninstall-app

描述: 从站点卸载 Frappe 应用。 用法: bench uninstall-app [应用名称] [选项] 说明: uninstall-app 命令用于从指定站点卸载特定的 Frappe 应用。通过运行此命令并提供要卸载的应用名称 [应用名称]，你可以将该应用从指定站点中卸载。这将移除应用的相关文件和数据库表，从而将应用从站点中清除。 请注意，在运行此命令时，确保备份站点数据以避免意外数据丢失。卸载应用是一个敏感操作，应谨慎执行，并确保在安全的环境中进行。

update-translations

描述: 更新翻译字符串。 用法: bench update-translations [选项] 说明: update-translations 命令用于更新 Frappe 应用程序中的翻译字符串。运行此命令会更新应用程序中的翻译文本，确保它们反映最新的更改和添加。翻译对于确保应用程序的多语言支持至关重要，通过运行此命令，你可以保持翻译的最新状态。

use

描述: 设置默认站点。 用法: bench use [站点名称] 说明: use 命令用于设置默认站点，该站点将作为 bench 的默认站点。通过运行此命令并提供站点名称 [站点名称]，你可以将指定的站点设置为 bench 的默认站点，以便在 bench 命令中自动使用该站点。这对于在多站点环境中管理 bench 非常有用。 请注意，指定的站点必须事先存在于 bench 中，否则此命令将无效。确保提供正确的站点名称，并在运行命令之前检查站点的存在。

version

描述: 显示已安装应用的版本信息。 用法: bench version [选项] 说明: version 命令用于显示已安装应用的版本信息。运行此命令会列出已安装应用的名称及其对应的版本号，以帮助你了解当前环境中各应用的版本情况。

watch

描述: 监视并实时编译 JS 和 CSS 文件。 用法: bench watch [选项] 说明: watch 命令用于监视 JS 和 CSS 文件的更改，并在文件发生更改时实时编译这些文件。通常在开发过程中，你会编辑 JS 和 CSS 文件来进行调试和测试。通过运行此命令，系统会持续监视文件的更改，并自动重新编译这些文件，以确保你对代码的更改能够立即反映在应用程序中。

worker

描述: 启动后台任务处理器。 用法: bench worker [选项] 说明: worker 命令用于启动 Frappe 应用程序的后台任务处理器。这些后台任务处理器负责处理异步任务，例如电子邮件发送、队列处理等。通过运行此命令，你可以启动后台任务处理器，确保异步任务能够按照预期执行。 请注意，后台任务处理器是应用程序的重要组成部分，通常应保持运行状态以确保应用程序的各种功能正常运作。确保有适当的权限来启动后台任务处理器，并在需要时按需启动。

以下内容为解决特殊问题由群友提供：

bench --site [sitename] --force reinstall

描述: 强制重新安装指定站点。 用法: bench --site [站点名称] --force reinstall 说明: bench --site [站点名称] --force reinstall 命令用于强制重新安装指定的站点。通过运行此命令，你可以重新安装特定的站点，即使该站点已存在。使用 --force 标志可以强制执行此操作。 请注意，重新安装站点将清除站点数据和设置，然后重新初始化该站点。 如果以上语句提示错误，bench找不到 --site 参数的话，可以用下面两条语句替代 bench use [sitename] bench --force reinstall 这可能导致数据丢失和站点配置重置。确保提供正确的站点名称，并在运行命令之前备份站点数据以避免数据丢失。谨慎使用 --force 标志，以免造成不可恢复的损失。

bench build --force

描述: 强制重新构建 Frappe 应用程序。 用法: bench build --force 说明: bench build --force 命令用于强制重新构建 Frappe 应用程序。通过运行此命令，你可以重新构建应用程序的前端资源，包括编译 JS 和 CSS 文件等。使用 --force 标志可以强制执行此操作。 请注意，重新构建应用程序可能会清除先前生成的构建文件并重新生成。确保在运行此命令之前备份必要的文件以避免数据丢失。谨慎使用 --force 标志，以免造成不可逆转的更改。