跳至主要内容
版本:1.2.0

命令列工具

介紹 GenAI Studio 提供的命令列工具(CLI)以及如何使用它們。

簡介

GenAI Studio 是基於 Ubuntu Linux 的 AI 平台。我們提供多個命令列工具(CLI)來輕鬆管理 GenAI Studio。 本文件提供您熟悉這些工具所需的所有資訊。

在繼續之前,您需要知道所有命令列工具都位於安裝目錄下的 bin 資料夾內。此外,當您在 bin 目錄內遇到類似 app-ps: command not found 問題時,只需添加 ./ 以便 shell 能為您找到正確的工具。例如,./app-up

服務管理命令

第一部分要介紹的命令列工具是服務管理命令。它們以前綴 app- 命名。大多數都接受額外參數,即特定服務名稱,以便只顯示該服務的資訊。 您可以提供的服務名稱如下所列:

  • autoheal
  • dcgm-exporter
  • flowise
  • ftp
  • grafana
  • node-exporter
  • ollama
  • postgresql
  • prometheus
  • qdrant
  • server
訊息

autohealdcgm-exporterflowiseftpgrafananode-exporterprometheus 自 v1.1.0 版本開始提供。

特別注意

除了 server 服務外,除非您知道自己在做什麼,否則不要對其他服務執行任何操作。

app-up

此命令列工具啟動所有服務。如果您只想啟動單個服務,請將該服務名稱作為參數提供。以下列出範例。

  • ./app-up 啟動所有服務。
  • ./app-up server 啟動 GenAI Studio 伺服器以及所有相依服務。

app-down

此命令列工具是 app-up 的對應工具。它關閉所有服務。此外,如果您提供特定服務名稱作為參數,它也可以關閉單個服務。

app-logs

此命令列工具提供簡單的方式來顯示所有服務的日誌訊息。通常建議將服務名稱作為參數提供,以便只顯示該特定服務的日誌。 此外,額外選項 -f 表示輸出將 跟隨 最新訊息,而選項 -t 顯示訊息記錄的時間戳。

下圖是執行命令 ./app-logs server -ft 所擷取的。

app-logs

app-ps

此命令列工具顯示目前正在執行的服務。我們很少像其他命令列工具那樣提供服務名稱,儘管我們可以這樣做。

下圖顯示了 ./app-ps 的結果。

app-ps

app-restart

此命令列工具重新啟動服務。不建議使用這個工具,因為服務可能需要完全重新載入,請改用 app-downapp-up

app-version

此命令列工具只是顯示 GenAI Studio 版本。這是唯一一個您不需要且不能提供服務名稱作為額外參數的命令列工具。

訊息

app-version 自 v1.1.0 版本開始提供。

模型管理命令

無論您想在 GenAI Studio 平台上做什麼,模型無疑永遠是您最感興趣或最關心的。GenAI Studio 處理兩種類型的模型:訓練模型和推理模型。 前者尚未準備就緒(將在不久的將來提供),而後者已經可用。

ollama-model

此命令列工具讓系統管理員能輕鬆管理 GenAI Studio 中 Ollama 推論伺服器能使用的模型。透過此工具,管理員可以:

  • 知道 GenAI Studio 中的 Ollama 目前可使用的模型有那些。
  • 將 GenAI Studio 中 Ollama 的模型匯出成可讓 GenAI Studio 後續使用的模型檔。
  • 從 Ollama 線上儲存庫或 GenAI Studio 製作的模型檔進行模型匯入的動作。
  • 將不用的模型自 GenAI Studio 中的 Ollama 進行移除。
訊息

ollama-model 自 v1.1.0 版本開始提供。

底下以一些簡單的案例說明如何使用此命令列工具。

案例 1:列出 GenAI Studio 中的 Ollama 有那些模型可使用

想知道 GenAI Studio 中的 Ollama 目前有那些模型可供使用,可透過 list 子命令列出所有的模型。

$ ./ollama-model list --from-builtin
NAME ID SIZE MODIFIED
phi3.5:latest 61819fb370a3 2.2 GB 13 days ago
gpt-oss:20b f2b8351c629c 13 GB 4 weeks ago
gemma3:27b-it-qat 29eb0b9aeda3 18 GB 4 months ago
deepseek-r1:32b 38056bbcbb2d 19 GB 5 months ago
mistral-nemo:latest 994f3b8b7801 7.1 GB 5 months ago

案例 2:將 GenAI Studio 中 Ollama 的模型匯出成 GenAI Studio 的模型檔

使用 export 子命令將 GenAI Studio 中 Ollama 的模型匯出成 GenAI Studio 的模型檔。要匯出的模型必須已存在 Ollama 中,可用 list 子命令進行查詢。承案例 1,下面的指令可將模型 phi3.5 從 GenAI Studio 中的 Ollama 匯出成 GenAI Studio 的模型檔。

ollama-model export phi3.5 --from-builtin

執行完畢之後會在當前目錄下產生一個名為 phi3.5-latest.model 的模型檔。

提示

這裡使用 phi3.5 而不是案例 1 中所列出的 phi3.5:latest,如果省略冒號 (:) 之後的文字,此命令列工具會自動預設並補上 latest 為此模型的版本。當然,也可以執行 ollama-model export phi3.5:latest --from-builtin 直接指名模型的版本。

案例 3:從 GenAI Studio 製作的模型檔進行模型匯入

利用 import 子命令將上例中的 phi3.5-latest.model 模型檔匯入 GenAI Studio 中的 Ollama。如果檔案 phi3.5-latest.model 不在當前目錄,記得將最後一個參數修改成正確的路徑。

ollama-model import phi3.5-latest.model

案例 4:從 Ollama 線上儲存庫直接將模型匯入到 GenAI Studio 中的 Ollama

下列指令可直接從 Ollama 線上儲存庫將 gpt-oss 匯入 GenAI Studio 中的 Ollama。

ollama-model import gpt-oss --from-registry

案例 5:將模型從 GenAI Studio 中的 Ollama 進行刪除

要將模型 gpt-oss 從 GenAI Studio 中的 Ollama 進行刪除,則是透過 remove 子命令。

ollama-model remove gpt-oss --from-builtin
提示

ollama-model 除了上述的基本用法之外,亦允許管理員與 GenAI Studio 之外的 Ollama 進行少許操作,執行 ollama-model --help 可以取得完整的用法及其相關資訊。

模型上下文協定 (MCP) 伺服器管理命令

模型上下文協定全名為 Model Context Protocol,簡稱 MCP。是一個為 AI 用戶端提供上下文、工具和提示的系統。 它可以公開文件、文件、資料庫和 API 整合等資料來源,使 AI 助理能夠以安全的方式存取即時資訊。GenAI Studio 從版本 1.2.0 開始支援 MCP 伺服器的整合,亦同時預載了下列指令以支援 MCP 伺服器的運作:

  • npx
  • uvuvx
  • node
  • bash

mcp-server

GenAI Studio 提供了 mcp-server 命令列工具讓管理員將使用者需要的相關工具與 GenAI Studio 進行無縫整合,透過 mcp-server 管理員可以:

  • 列出目前與 GenAI Studio 整合的 MCP 伺服器列表。
  • 將 MCP 伺服器匯入至 GenAI Studio。
  • 將 MCP 伺服器自 GenAI Studio 中移除。

以下以簡單案例進行解說。

案例 1:將 MCP 伺服器匯入至 GenAI Studio

子命令 import 可以將 MCP 伺服器匯入至 GenAI Studio,其使用方式如下所示。

mcp-server import --source SRC_PATH --config CONFIG_FILE

這裡的 SRC_PATH 是 MCP 伺服器的執行期環境壓縮檔 (.zip),而 CONFIG_FILE 則是對應此 MCP 伺服器的設定檔。 下面顯示了一個最基本的 MCP 伺服器設定檔的內容。

{
"My MCP Server": {
"command": "npx",
"args": [
"tsx",
"%%My MCP Server%%/index.ts"
],
"env": {
"GRAFANA_URL": "http://grafana:3000",
"GRAFANA_API_KEY": "glsa_aIude91214fryVZ6tIVFYczXpemKm8sFmdXatem3_"
}
}
}
  • 第 2 行中的 My MCP Server 是要匯入的 MCP 伺服器名稱,會顯示在 系統設定 > 代理技能 > MCP Servers 的列表中,且必須是唯一的 (如下圖)。 mcp-list

  • 第 6 行中的 %%My MCP Server%% 在匯入時會被代換為該 MCP 伺服器所在的實際目錄,這裡的 My MCP Server 與第 2 行的名稱必須一致。

案例 2:列出目前與 GenAI Studio 整合的 MCP 伺服器

利用子命令 listls 可以列出目前與 GenAI Studio 整合的 MCP 伺服器名稱。

mcp-server list

案例 3:將 MCP 伺服器從 GenAI Studio 中移除

子命令 remove 則可將已整合在 GenAI Studio 中的 MCP 伺服器逕行移除。

mcp-server remove "My MCP Server"
提示

由於 My MCP Server 包含了空白字元,如果沒有以雙引號包夾會導致 mcp-server 執行錯誤。