CLI 指令
這是一份詳盡的 OrpheAgent CLI 指令指南，協助您管理與操作 Agent。
CLI 指令
OrpheAgent 提供了一套完整的命令列介面 (CLI) 指令，讓您可以管理、設定與操作 Agent。以下是可用的指令、功能說明以及支援的選項。
啟動 Agent
使用 up 指令來啟動 OrpheAgent：
orphe-agent up
別名： orphe-agent u
選項：
-d, --debug：啟用除錯 (debug) 模式，提供詳細的日誌以利排解問題。-f, --foreground：在前景模式下執行 Agent，而非作為守護行程 (daemon) 在背景執行。
停止 Agent
使用 down 指令來停止 OrpheAgent：
orphe-agent down
別名： orphe-agent d
systemd 服務正在執行時，此指令會停止該服務；若服務未啟用，則會向目前以前景模式執行的 Agent 傳送關機事件。
重新啟動 Agent
使用 restart 指令來重新啟動 OrpheAgent：
orphe-agent restart
別名： orphe-agent r
此指令會停止目前執行中的 Agent，然後重新啟動。這相當於先執行 orphe-agent down，隨後再執行 orphe-agent up。
設定管理 (Configuration)
使用 config 指令來管理各項設定。您可以個別設定每個選項。請注意，任何變更都必須在執行 save 動作後才會生效。
orphe-agent config ACTION
別名： orphe-agent c ACTION
支援的動作：
save：將目前的設定儲存至預設的設定檔。clean：清除現有設定並還原為預設值。show：以易讀的格式顯示目前的設定內容。
選項：
-p, --provision-key：指定供裝金鑰（Provision Key，例如12D3KooWS）。-n, --host-name：設定主機名稱 (例如orphe-agent)。-h, --mgmt-port-http：設定 HTTP 管理連接埠 (預設值：0)；使用none停用 HTTP 管理介面。-s, --mgmt-port-https：設定 HTTPS 管理連接埠 (預設值：0)；使用none停用 HTTPS 管理介面。-c, --controlplane-tun-port：設定控制層 (Control Plane) 隧道連接埠 (預設值：0)。-d, --dataplane-tun-port：設定資料層 (Data Plane) 隧道連接埠 (預設值：0)。
!TIP 輸入
0可讓系統自動指派隨機連接埠。HTTP 與 HTTPS 管理介面不可同時設為none；所有非零連接埠必須彼此不同且尚未被占用。
範例：
- 顯示目前的設定：
orphe-agent config show - 使用自訂的 Provision Key 與主機名稱儲存設定：
orphe-agent config save --provision-key 12D3KooWS --host-name my-agent - 停用 HTTP 管理介面並將 HTTPS 管理連接埠設為
443：orphe-agent config save --mgmt-port-http none --mgmt-port-https 443 - 將設定重設為預設值：
orphe-agent config clean
設定檔管理 (Profile)
使用 profile 指令來管理多個設定檔 (Profile)：
orphe-agent profile ACTION
別名： orphe-agent pf ACTION
支援的動作：
list：顯示所有可用的設定檔及其目前的使用狀態。create：使用指定的名稱建立新的設定檔。delete：刪除現有的設定檔。use：切換並啟用特定的設定檔，然後使用所選設定檔重新載入 OrpheAgent。
選項：
-n, --name：設定檔的名稱 (在執行create、delete及use動作時為必填)。
範例：
- 列出所有設定檔：
orphe-agent profile list - 建立一個名為 "production" 的新設定檔：
orphe-agent profile create -n production - 切換至 "production" 設定檔：
orphe-agent profile use -n production - 刪除 "staging" 設定檔：
orphe-agent profile delete -n staging
!NOTE 預設設定檔不可刪除。刪除目前使用中的設定檔前，必須先切換至其他設定檔；刪除時需在提示中輸入
yes確認。
供裝管理（Provision）
使用 provision 指令設定供裝過程中的設備探索功能：
orphe-agent provision ACTION
別名： orphe-agent p ACTION
支援的動作：
save：儲存目前的供裝設定。clean：清除供裝設定並還原為預設值。show：以易讀的格式顯示目前的供裝設定內容。
選項：
-x, --multicast：啟用或停用 Multicast 探索 (true或false)。-m, --mdns：啟用或停用 MDNS 探索 (true或false)。-r, --relay：啟用或停用 Relay 探索 (true或false)。
!NOTE 每個布林值選項僅接受
true或false(不分大小寫)。
範例：
- 顯示目前的供裝設定：
orphe-agent provision show - 啟用 Multicast 和 MDNS，並停用 Relay：
orphe-agent provision save --multicast true --mdns true --relay false - 將供裝設定重設為預設值：
orphe-agent provision clean
控制層 P2P 管理 (Control Plane)
使用 control-plane-p2p 指令來設定控制層的 P2P 網路：
orphe-agent control-plane-p2p ACTION
別名： orphe-agent cp-p2p ACTION
支援的動作：
save：儲存目前的 P2P 設定。show：顯示目前的 P2P 設定內容。clean：將 P2P 設定重設為預設值。
選項：
-d, --dht：啟用或停用 DHT 探索 (true或false)。-u, --udp-hole-punch：啟用或停用 UDP Hole Punch (UDP 打洞功能) (true或false)。-r, --relay：啟用或停用 Relay 傳輸 (true或false)。
!NOTE 每個布林值選項僅接受
true或false(不分大小寫)。
範例：
- 顯示目前的 P2P 設定：
orphe-agent control-plane-p2p show - 啟用 DHT 和 Relay，並停用 UDP Hole Punch：
orphe-agent control-plane-p2p save --dht true --relay true --udp-hole-punch false - 將控制層 P2P 設定重設為預設值：
orphe-agent control-plane-p2p clean
資料層 P2P 管理 (Data Plane)
使用 dataplane-p2p 指令來設定資料層的 P2P 網路：
orphe-agent dataplane-p2p ACTION
別名： orphe-agent dp-p2p ACTION
支援的動作：
save：儲存目前的 P2P 設定。show：顯示目前的 P2P 設定內容。clean：將 P2P 設定重設為預設值。up：啟用 (Bring up) 資料層。down：停用 (Bring down) 資料層。
選項：
-d, --dht：啟用或停用 DHT 探索 (true或false)。-u, --udp-hole-punch：啟用或停用 UDP Hole Punch (UDP 打洞功能) (true或false)。-r, --relay：啟用或停用 Relay 傳輸 (true或false)。-b, --dataplane-on-boot：啟用或停用在開機時自動啟動資料層 (true或false)。-s, --snat：針對資料層流量啟用或停用 SNAT (來源網路位址轉換) (true或false)。-t, --tun-mode：設定資料層的隧道模式：low_latency(低延遲) 或high_throughput(高吞吐量) (預設值：high_throughput)。
!NOTE 每個布林值選項僅接受
true或false(不分大小寫)。
範例：
- 顯示目前的 P2P 設定：
orphe-agent dataplane-p2p show - 啟用 DHT 和 Relay，並停用 UDP Hole Punch：
orphe-agent dataplane-p2p save --dht true --relay true --udp-hole-punch false - 將資料層隧道模式設定為低延遲：
orphe-agent dataplane-p2p save --tun-mode low_latency - 針對資料層流量啟用 SNAT：
orphe-agent dataplane-p2p save --snat true - 啟用資料層：
orphe-agent dataplane-p2p up - 停用資料層：
orphe-agent dataplane-p2p down - 將資料層 P2P 設定重設為預設值：
orphe-agent dataplane-p2p clean
系統檢查 (System Check)
執行 system-check 指令以針對 OrpheAgent 進行系統相容性檢查：
orphe-agent system-check
別名： orphe-agent sc
此指令會驗證主機系統是否支援讓 Agent 正常運作所需的功能。
狀態指令 (Status)
使用 status 指令來檢查 OrpheAgent 的運作狀態：
orphe-agent status
別名： orphe-agent s
選項：
-d, --dp-link-status：顯示資料層的連線狀態。-c, --cp-link-status：顯示控制層的連線狀態。-n, --nat-type：顯示偵測到的 NAT 類型與 P2P 相容性說明。
未指定選項時，指令會顯示服務、控制平面連線及資料平面連線狀態；指定選項時則只顯示要求的資訊。連線狀態包含延遲 (latency)、抖動 (jitter) 及資料傳輸率 (data rate) 等指標。
範例：
orphe-agent status
orphe-agent status --dp-link-status
orphe-agent status --cp-link-status
orphe-agent status --nat-type
說明指令 (Help)
使用 help 指令來取得特定子指令的使用說明：
orphe-agent help
別名： orphe-agent h
此指令會顯示指定子指令的詳細用法及可用選項。例如，要取得 up 指令的說明：
orphe-agent help up
版本指令 (Version)
使用 version 指令以輸出目前安裝的 OrpheAgent CLI 版本：
orphe-agent version
別名： orphe-agent v
此指令會輸出已安裝的 OrpheAgent 二進位檔版本資訊，對於排解問題及驗證部署十分有用。
更新指令 (Update)
使用 update 指令來檢查是否有可用的更新，並安裝最新版本的 OrpheAgent：
orphe-agent update
別名： orphe-agent upd
此指令會檢查是否有新版的 OrpheAgent，下載更新檔並自動進行安裝。
選項：
-c, --check：僅檢查是否有可用更新，而不進行安裝。
範例：
- 檢查更新並立即安裝：
orphe-agent update - 僅檢查是否有新的更新檔：
orphe-agent update --check
取得更多指令資訊
如需其他說明，請參閱專案文件，或執行 orphe-agent help 查看各指令的詳細用法。