---
schema_version: "1"
id: 3dbaf71f9fdcd6506505e51f85df9cecad7a4561eda3cc28a406f51ed811ee51
title: Tableau Prep 命令行参考
collection: tableau
version: current
locale: zh-cn
portal_url: https://docs.salesforce.com/tableau/current/zh-cn/prep/prep_command_line_reference.md
canonical_url: https://help.tableau.com/current/prep/zh-cn/prep_command_line_reference.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 2fe1bd11dec4d296b976c8448107860d536e771c2a0f69a7a6f229962abae1f2
description: Reference for interacting with Tableau Prep through the command line.
---
[跳转到主要内容](#main-content)

# Tableau Prep 命令行参考

您可以使用命令行通过主应用程序 (Tableau Prep.exe) 或命令行界面 (tableau-prep-cli.bat) 与 Tableau Prep 交互。

- Tableau Prep.exe：用于配置应用程序自身初始化的方式。例如，安装、激活、许可、设置用户数据目录或对 Electron 外壳进行故障排除。
- Tableau-prep-cli.bat：用于运行流程。例如，在不打开可视界面的情况下传递凭据、参数和刷新数据输出。

本文档介绍 Tableau Prep 支持并可供客户使用的所有命令行语法选项，并按可用实用工具进行分类说明。

本文档中未包括 Tableau 开发人员和支持人员使用的其他受支持的命令行语法。

## Tableau Prep 应用程序

对于 Tableau Prep.exe 应用程序，可以通过命令行执行以下操作。

### 安装

以管理员身份从计算机的命令行中运行安装程序 .exe 文件，安装 Tableau Prep。有关详细信息，请参见[通过命令行安装](https://help.tableau.com/current/desktopdeploy/zh-cn/desktop_deploy_automate.htm)。

**注意：**此选项仅适用于 Windows。

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 276px;"><col style="width: 875px;"></colgroup><tbody><tr><th>语法</th><th>描述</th></tr><tr><td><code>tableau_&lt;product_installer_name&gt;.exe /option1 /option2 PROPERTY1 PROPERTY2</code></td><td><p>以管理员身份从 .exe 文件所在的目录运行命令，或指定计算机上 .exe 文件位置的完整路径。不要从共享目录运行。有关支持的安装程序选项的列表，请参见<a href="https://help.tableau.com/current/desktopdeploy/zh-cn/desktop_deploy_cli_ref.htm#installer-options" target="_blank">安装程序选项</a>。有关支持的安装程序属性的列表，请参见<a href="https://help.tableau.com/current/desktopdeploy/zh-cn/desktop_deploy_cli_ref.htm#installer-properties" target="_blank">安装程序属性</a>。</p><ul><li><p><code>tableau_&lt;product_installer_name&gt;.exe</code> 是您所安装的产品和版本的 Tableau 安装程序。</p></li><li><p><code>option1, option2</code> 等是您希望安装过程运行的方式。</p></li><li><p><code>PROPERTY1, PROPERTY2</code> 等允许您指定安装程序在安装过程中应进行的配置设置。</p></li></ul><p>示例：</p><p><code>tableauPrepBuilder-64bit-2026-2-0.exe /quiet /norestart ACCEPTEULA=1 CRASHDUMP="0" SENDTELEMETRY="0"</code></p><p>此命令在无提示模式下安装 Tableau 版本 2026.2（不显示提示符、UI 或许可证对话框）。它将在不重新启动的情况下完成安装，接受最终用户许可协议 (EULA)，并将错误报告和使用情况报告设置为关闭。</p></td></tr></tbody></table>

### 激活、许可证和注册

使用这些命令检查许可证、在安装过程中或安装后激活产品，以及注册产品。有关详细信息，请参见[“激活 Tableau Desktop 和 Tableau Prep Builder”](https://help.tableau.com/current/desktopdeploy/zh-cn/desktop_deploy_automate.htm#activate-tableau-desktop-and-tableau-prep-builder)。

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 276px;"><col></colgroup><tbody><tr><th>语法</th><th>描述</th></tr><tr><td><code>--activate &lt;key&gt;</code></td><td><p>使用提供的产品密钥激活产品。成功时退出并显示代码 0。其他情况下退出并显示错误代码。也接受单破折号 (-activate)。</p><p>若要在安装期间激活产品，请添加一个包括安装程序选项 ACTIVATE_KEY "&lt;key&gt;" 的命令行，并在引号中输入产品密钥。</p></td></tr><tr><td><code>--register </code></td><td><p>注册产品。也接受单破折号 (-register)。若要通过命令行注册 Tableau，您需要在将运行 Tableau Prep Builder 的每台计算机上预先填充注册表 (Windows) 或 .plist (Mac) 值。</p><p>对于 Windows，您可以通过添加包括安装程序选项 REGISTER="1" 的单一命令行，在安装过程中注册产品。</p><p>有关详细信息，请参见<a href="https://help.tableau.com/current/desktopdeploy/zh-cn/desktop_deploy_automate.htm#register-tableau-desktop-and-tableau-prep-builder" target="_blank">注册 Tableau Desktop 和 Tableau Prep Builder</a>。</p></td></tr><tr><td><code>--check-license </code></td><td>如果未获得许可，则显示激活 UI。</td></tr><tr><td><code>--refresh</code></td><td><p>使用许可证的当前维护期的到期日期更新许可证，并停止发送到期消息。成功时退出并显示代码 0。也接受单破折号 (-refresh)。</p><p><b>Windows</b>：使用 <code>--refresh</code> 选项和产品密钥运行 tableau.exe。</p><p><b>MacOS</b>：对 /Applications 路径中的 Tableau 对象运行 <code>-refresh</code> 选项。</p></td></tr><tr><td><code>--return &lt;key&gt;</code></td><td><p>停用提供的产品密钥，以便可以重复使用。也接受单破折号 (-return)。</p><p><b>Windows</b>：使用 <code>-return</code> 选项和产品密钥运行 tableau.exe。</p><p><b>MacOS</b>：对 /Applications 路径中的 Tableau 对象运行 <code>-return</code> 选项。</p></td></tr></tbody></table>

### 配置和存储

使用这些命令来配置文件设置和存储库位置。

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 276px;"><col></colgroup><tbody><tr><th>语法</th><th>描述</th></tr><tr><td><code>--settings-file &lt;file location&gt;</code></td><td><p>从给定文件加载应用程序配置设置。可以多次指定以支持分层配置，例如当您有每个人都使用的全局代理服务器配置，以及用于流程的特定数据库配置时。</p><p>.json 文件示例:</p><pre xml:space="preserve">{
 "connection-sources":[
  {
	"endpoint":"prod-db-server.company.com",
	"username":"service_account_admin",
	"password":"secure_password_123"
	}
 ]
}</pre><p>示例命令：</p><p><b>Windows</b>：<code>"C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --settings-file "C:\ProgramData\Tableau\global-proxy-config.json" --settings-file  "C:\Users\jsmith\AppData\Roaming\Tableau\db-config.json"</code></p><p><b>MacOS</b><code>: /Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --settings-file "/Library/Tableau/global-proxy-config.json" --settings-file "/Users/jsmith/Library/Application Support/Tableau/db-config.json"</code></p></td></tr><tr><td><code>--repository-location &lt;file path&gt; </code></td><td><p>设置存储库目录。默认情况下，在安装过程中，Tableau Prep 会在您的“文档”文件夹中创建一个名为“我的 Tableau Prep 存储库”的文件夹。此文件夹包括流程、数据源、连接以及日志文件的文件夹，以及临时缓存。在服务器或自动化环境中，可以使用此命令指定备用存储库位置，并将流程运行指向该位置。</p><p>示例：</p><p><b>Windows</b>："<code>C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --repository-location "D:\Tableau_Data\My_Prep_Repo"</code></p><p><b>MacOS</b>：<code>/Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --repository-location "/Users/jsmith/Documents/My Tableau Prep Repository"</code></p></td></tr><tr><td><code>--user-data-directory &lt;location&gt;</code></td><td><p>用于存储 Electron 应用程序数据的目录。</p><p><code>--repository-location</code> 管理您的业务资产（日志和数据），而 <code>--user-data-directory</code> 管理应用程序的内部引擎。</p><p>作为管理员，如果您在多个进程需要隔离应用程序状态的高并发环境中运行 Tableau Prep Builder，或者在无头服务器上排查持久性会话锁定错误时，请使用此标志。</p><p class="note"><b>注意</b>：运行该命令时，它会自动创建 <code>--user-data-directory</code> 中指定的文件夹。但是，运行脚本的用户帐户必须具有该父目录的“写入”权限。</p><p>示例：</p><p><b>Windows</b>：<code> "C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --user-data-directory "D:\Tableau_Data\Prep_AppData"</code></p><p><b>MacOS</b>：<code>/Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --user-data-directory "/Users/jsmith/Library/Application Support/Tableau Prep"</code></p></td></tr></tbody></table>

### 打开文件

使用这些命令打开 .tfl 和 .tflx Tableau Prep 流程文件。

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 276px;"><col></colgroup><tbody><tr><th>语法</th><th>描述</th></tr><tr><td><code>--tfl&lt;file&gt;</code></td><td><p>打开指定的 .tfl 流程文件。如果文件路径包括空格，请使用双引号。</p><p>示例：</p><p><b>Windows</b>："C：\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" -tfl "C：\用户\jsmith\文档\我的流程\Clean_Sales_Data.tfl"</p><p><b>MacOS：</b>/Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder -tfl "/Users/jsmith/Documents/My Flows/Clean_Sales_Data.tfl"</p></td></tr><tr><td><code>--tflx&lt;file&gt; </code></td><td><p>打开指定的 .tflx 打包流程文件。</p><p>示例：</p><p><b>Windows</b>：<code>"C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --tflx "C:\Users\jsmith\Desktop\Quarterly_Report.tflx"</code></p><p><b>MacOS</b>：<code>/Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --tflx "/Users/jsmith/Desktop/Quarterly_Report.tflx"</code></p></td></tr></tbody></table>

## Tableau Prep 命令行应用程序

可以使用 Tableau Prep 命令行界面 (tableau-prep-cli.bat) 运行以下命令。

### 刷新流程输出

使用这些选项从命令行运行流程以刷新流程输出。此方法一次只允许您运行一个流程。有关详细信息和限制，请参见[通过命令行刷新流程输出文件](https://help.tableau.com/current/prep/zh-cn/prep_run_commandline.htm)。

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 276px;"><col></colgroup><tbody><tr><th>语法</th><th>描述</th></tr><tr><td><code>-c, --connections &lt;path&gt;</code></td><td><p>包含数据源和服务器凭据的 .json 文件的路径。</p><p>如果使用远程连接，Tableau Prep Builder 将使用流程文件和凭据 .json 文件中的信息来运行流程。有关详细信息，请参见 <a href="https://help.tableau.com/current/prep/zh-cn/prep_run_commandline.htm#credentials-json-file-requirements" target="_blank">凭据 .json 文件要求</a>。</p><p>如果连接到 Snowflake 数据库，请确保包括任何特定参数，例如角色、仓库，有时还要包括 OAuth 令牌或外部浏览器身份验证。</p><p>.json 设置文件示例 - Snowflake：</p><pre xml:space="preserve">{
 "connection-sources":[
  {
	"endpoint":"company_account.snowflakecomputing.com",
	"username":"SVC_TABLEAU_PREP",
	"password":"EncryptedPassword123",
	"attributes":{
	 "warehouse": "DATA_LOAD_WH",
	 "role": "TRANSFORM_ROLE"
	}
  }
 ]
}						</pre><p>示例：</p><p><b>Windows</b>：<code> "\[Tableau Prep Builder install location]\Tableau Prep Builder &lt;version&gt;\scripts"\tableau-prep-cli.bat -c "path\to\[your credential file name].json" -t "path\to\[your flow file name].tfl"</code></p><p><b>MacOS</b>：<code> /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -c path/to/[your credential file name].json -t path/to/[your flow file name].tfl</code></p></td></tr><tr><td><code>- p,  - - parameters</code></td><td><p>覆盖流程中默认参数值的 .json 文件的路径。这是一个独立于您的 credentials.json 文件的文件，包含您的参数名称和值。</p><p>有关详细信息，请参见<a href="https://help.tableau.com/current/prep/zh-cn/prep_run_commandline.htm#credentials-json-file-requirements" target="_blank">凭据 .json 文件要求</a>中的“运行包含参数值的流程”。</p><p>示例：</p><p><b>Windows</b>：<code>"\[Tableau Prep Builder install location]\Tableau Prep Builder &lt;version&gt;\scripts"\tableau-prep-cli.bat -t "path\to\[your flow file name].tfl" -p|--parameters parameters.override.json</code></p><p><b>MacOS</b>：<code>/Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -t path/to/[your flow file name].tfl -p|--parameters parameters.override.json</code></p></td></tr><tr><td><code>-t,--tflFile &lt;file path&gt;</code></td><td>Tableau Prep 流程文件的路径。</td></tr><tr><td><code>-inc, --incrementalRefresh </code></td><td><p>如果在服务器上未启用 Tableau Prep Conductor 来计划流程运行，则可以通过增量刷新使用此命令来运行流程。有关详细信息，请参见“在启用增量刷新的情况下运行流程”。</p><p>示例：</p><p><b>Windows</b>：<code>"\[Tableau Prep Builder install location]\Tableau Prep Builder &lt;version&gt;\scripts"\tableau-prep-cli.bat --incrementalRefresh -t "path\to\[your flow file name].tfl"</code></p><p><b>MacOS</b>：<code>/Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli --incrementalRefresh -t path/to/[your flow file name].tfl</code></p></td></tr></tbody></table>

### 其他命令

使用这些命令打印输出 Tableau Prep 版本、打开调试模式以调试流程进程、禁用 SSL 验证，等等。

<table style="width: 100%;" class="simple-table"><colgroup><col style="width: 276px;"><col></colgroup><tbody><tr><th>语法</th><th>描述</th></tr><tr><td><code>--version</code></td><td>输出 Tableau Prep Builder CLI 的当前版本，并立即终止进程。</td></tr><tr><td><code>-d, --debug </code></td><td><p>启用调试模式。在存储库文件夹中生成详细日志以进行故障排除。日志文件存储位置：我的 Tableau Prep Builder 存储库\Command Line Repository\Logs</p><p>示例：</p><p><b>Windows</b>：<code>"\[Tableau Prep Builder install location]\Tableau Prep Builder &lt;version&gt;\scripts"\tableau-prep-cli.bat --debug -t "[your flow file name].tfl"</code></p><p><b>MacOS</b>：<code>/Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli --debug -t “[your flow file name]”.tfl</code></p></td></tr><tr><td><code>-dsv, --disableSslValidation </code></td><td><p>禁用 SSL 证书验证（对于某些内部服务器环境很有用）。在 MacOS 上运行此选项时，可能会显示一个对话框，询问钥匙串用户和密码。</p><p>从 Tableau Prep Builder 版本 2019.3.2 开始，您可以传入此附加参数来禁用此钥匙串对话框。</p><p>示例：</p><p><b>MacOS</b>：<code>/Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -dsv -c path/to/[your credential file name].json -t path/to/[your flow file name].tfl</code></p></td></tr><tr><td><code>-h, --help</code></td><td><p>显示命令行选项的帮助菜单。</p></td></tr></tbody></table>