AgentBuilder CLI
AgentBuilder 命令列介面是管理和運行 AgentBuilder 伺服器的主要介面。
當您安裝 AgentBuilder Python 套件時，AgentBuilder CLI 會自動安裝。 它不適用於 AgentBuilder Desktop.
如何使用 CLI
AgentBuilder CLI 可以根據您的安裝方法和環境以多種方式調用。
建議的方法是在安裝了 AgentBuilder 的虛擬環境中，使用 uv run 運行 CLI。
例如，要在預設連接埠上啟動 AgentBuilder，請運行以下命令：
_10uv run langflow run
如果 AgentBuilder 已全域安裝或新增到您的 PATH，您可以直接使用 langflow 執行 CLI。
_10langflow run
優先順序
AgentBuilder CLI 選項會覆蓋在您的終端機或主要 .env 檔案中設定的 環境變數 值。
例如，如果您將 LANGFLOW_PORT=7860 定義為環境變數，並使用 --port 7880 運行 CLI，則 AgentBuilder 會將連接埠設定為 7880，因為 CLI 選項會覆蓋環境變數。
這也適用於布林環境變數。
例如，如果您在 .env 檔案中設定 LANGFLOW_REMOVE_API_KEYS=True，您可以在運行時通過使用 --no-remove-api-keys 運行 CLI 將其更改為 False。
AgentBuilder CLI 選項
所有 AgentBuilder CLI 命令都支援修改命令行為或設定環境變數的選項。
要為選項設定值，您可以使用以下任一種語法樣式：
--option value--option=value
帶有空格的值必須用引號括起來：
--option 'Value with Spaces'--option="Value with Spaces"
布林選項
布林選項啟用和停用設定。 它們有一個真（啟用）和假（停用）形式：
- 啟用（真）：
--option - 停用（假）：
--no-option
以下示例比較 REMOVE_API_KEYS 的布林選項形式。
- True
- False
--remove-api-keys 等同於 在 .env 中設定 LANGFLOW_REMOVE_API_KEYS=True：
_10uv run langflow run --remove-api-keys
--no-remove-api-keys 等同於在 .env 中設定 LANGFLOW_REMOVE_API_KEYS=False：
_10uv run langflow run --no-remove-api-keys
在以下命令參考中，布林值的預設值包括 CLI 旗標和等效布林評估，例如 "--option (true)" 和 "--no-option (false)"。
通用選項
以下選項適用於所有 AgentBuilder CLI 命令：
--version,-v：顯示版本並退出。--install-completion：為當前 shell 安裝自動完成。--show-completion：顯示自動完成配置檔案的位置（如果已安裝）。--help：列印有關命令使用、選項和參數的資訊。
CLI 命令
以下各節描述可用的 CLI 命令以及每個命令可用的任何額外選項（除了 通用選項）。
langflow
運行 CLI 而不帶任何參數會列印可用選項和命令的列表。
- uv (recommended)
- Direct
_10uv run langflow
_10langflow
langflow api-key
建立 AgentBuilder API 金鑰。
您必須是超級使用者才能使用 CLI 建立 API 金鑰。 更多資訊請參閱 AgentBuilder API 金鑰。
- uv (recommended)
- Direct
_10uv run langflow api-key
_10langflow api-key
選項
| 選項 | 預設 | 類型 | 描述 |
|---|---|---|---|
--log-level | error | String | 日誌記錄級別。debug、info、warning、error 或 critical 之一。 |
langflow copy-db
從快取目錄複製 AgentBuilder 資料庫檔案到當前 AgentBuilder 安裝目錄，即包含 __main__.py 的目錄。
您可以通過運行 which langflow 找到複製目標目錄。
如果快取目錄中存在，以下檔案會被複製：
langflow.db：儲存在使用者快取目錄中的主要 AgentBuilder 資料庫langflow-pre.db：預發行資料庫（如果存在）
- uv (recommended)
- Direct
_10uv run langflow copy-db
_10langflow copy-db
langflow migration
使用 Alembic 管理 AgentBuilder 資料庫結構變更，Alembic 是 SQLAlchemy 的資料庫遷移工具。
migration 命令有兩種模式：
-
測試模式（預設）：檢查遷移是否可以安全應用，而不實際運行遷移。 使用此模式在繼續遷移之前預覽將對資料庫結構進行的更改。
-
修復模式：應用遷移以更新資料庫結構。
warninglangflow migration --fix是一個破壞性操作，可能會刪除資料。 始終先運行langflow migration以預覽更改。
- uv (recommended)
- Global
- 運行測試模式：
_10uv run langflow migration
-
預覽測試返回的更改，以確定是否安全繼續遷移。
-
運行修復模式以應用更改：
_10uv run langflow migration --fix
- 運行測試模式：
_10langflow migration
-
預覽測試返回的更改，以確定是否安全繼續遷移。
-
運行修復模式以應用更改：
_10langflow migration --fix
langflow run
啟動 AgentBuilder 伺服器。
- uv (recommended)
- Direct
_10uv run langflow run [OPTIONS]
_10langflow run [OPTIONS]
選項
此命令支援您的 AgentBuilder 伺服器的一些常見和非敏感配置選項。
其他選項必須在 .env 或您的終端機中設定。
有關更多 AgentBuilder 配置選項，請參閱 AgentBuilder 環境變數。
| 選項 | 預設 | 類型 | 描述 |
|---|---|---|---|
--auto-saving | --auto-saving (true) | Boolean | 是否在視覺編輯器中啟用FLOW自動儲存。使用 --no-auto-saving 停用FLOW自動儲存。 |
--auto-saving-interval | 1000 | Integer | FLOW自動儲存的間隔，以毫秒為單位。 |
--backend-only | --no-backend-only (false) | Boolean | 是否僅運行 AgentBuilder 的後端服務（無前端）。省略或使用 --no-backend-only 啟動前端和後端。請參閱 在無頭模式下啟動 AgentBuilder。 |
--cache | async | String | 要使用的 快取儲存 類型。async、redis、memory 或 disk 之一。 |
--components-path | Not set | String | 包含您的自訂Components的目錄路徑。 |
--dev | --no-dev (false) | Boolean | 是否在開發模式下運行（可能包含錯誤）。 |
--env-file | Not set | String | 包含 AgentBuilder 環境變數的 .env 檔案路徑。請參閱 使用特定 .env 檔案啟動 AgentBuilder。 |
--frontend-path | Not set | String | 包含建置檔案的前端目錄路徑。這僅在貢獻 AgentBuilder 程式碼庫或開發包含自訂前端程式碼的自訂 AgentBuilder 映像時使用。 |
--health-check-max-retries | 5 | Integer | 您的 AgentBuilder 伺服器健康檢查的最大重試次數。 |
--host | localhost | String | AgentBuilder 伺服器將運行的主機。 |
--log-file | logs/langflow.log | String | AgentBuilder 日誌檔案的路徑。 |
--log-level | critical | String | 日誌記錄級別，為 debug、info、warning、error 或 critical 之一。 |
--log-rotation | Not set | String | 日誌輪換間隔，可以是時間持續時間或檔案大小。 |
--max-file-size-upload | 1024 | Integer | 檔案上傳的最大大小，以 MB 為單位。 |
--open-browser | --no-open-browser (false) | Boolean | 是否在啟動時開啟系統網頁瀏覽器。使用 --open-browser 在 AgentBuilder 啟動時開啟系統預設網頁瀏覽器。 |
--port | 7860 | Integer | AgentBuilder 伺服器將運行的連接埠。如果指定的連接埠正在使用中，伺服器會自動選取一個可用連接埠。 |
--remove-api-keys | --no-remove-api-keys (false) | Boolean | 是否從儲存在 AgentBuilder 資料庫中的FLOW中移除 API 金鑰。 |
--ssl-cert-file-path | Not set | String | 本地系統上 SSL 加密連接的 SSL 憑證檔案路徑。 |
--ssl-key-file-path | Not set | String | 本地系統上 SSL 加密連接的 SSL 金鑰檔案路徑。 |
--worker-timeout | 300 | Integer | AgentBuilder 伺服器工作者逾時，以秒為單位。 |
--workers | 1 | Integer | AgentBuilder 伺服器工作者程序的數量。 |
使用特定 .env 檔案啟動 AgentBuilder
--env-file 選項使用給定 .env 檔案中定義的配置啟動 AgentBuilder。
附加到此命令的其他選項會覆蓋 .env 檔案中的值（如果有重複）。
如果省略 --env-file 或不包含所有必需變數，AgentBuilder 會為這些變數使用預設值。
- uv (recommended)
- Direct
_10uv run langflow run --env-file PATH/TO/LANGFLOW/.env
_10langflow run --env-file PATH/TO/LANGFLOW/.env
在無頭模式下啟動 AgentBuilder
--backend-only 選項僅啟動 AgentBuilder 的後端服務。
此無頭模式沒有前端（視覺編輯器），您只能使用 AgentBuilder API 和 CLI 以程式設計方式存取伺服器。
- uv (recommended)
- Direct
_10uv run langflow run --backend-only
_10langflow run --backend-only
langflow superuser
使用給定的使用者名稱和密碼建立超級使用者帳戶。
- uv (recommended)
- Direct
_10uv run langflow superuser --username [NAME] --password [PASSWORD] [OPTIONS]
_10langflow superuser --username [NAME] --password [PASSWORD] [OPTIONS]
選項
| 選項 | 預設 | 類型 | 描述 |
|---|---|---|---|
--log-level | error | String | 日誌記錄級別。debug、info、warning、error 或 critical 之一。 |
對於此命令，--username 和 --password 不是可選的，並且沒有預設值。
如果您不提供這些參數，命令會失敗。
更多資訊請參閱 LANGFLOW_SUPERUSER 和 LANGFLOW_SUPERUSER_PASSWORD。
停用 CLI 超級使用者建立
langflow superuser 命令由 LANGFLOW_ENABLE_SUPERUSER_CLI 環境變數控制：
LANGFLOW_ENABLE_SUPERUSER_CLI=True（預設）：langflow superuser命令可用，超級使用者建立不受限制。LANGFLOW_ENABLE_SUPERUSER_CLI=False（建議）：停用langflow superuser命令。 出於安全原因，這是建議的，以防止未經授權的超級使用者建立，特別是在生產環境中。
要停用 langflow superuser 命令，您必須在您的 AgentBuilder .env 檔案中設定 LANGFLOW_ENABLE_SUPERUSER_CLI=False，然後 使用您的 .env 檔案啟動 AgentBuilder。
