seqcli

seqcli

Seq 客戶端命令列應用程式。支援日誌記錄 ( seqcli log )、搜尋 ( search )、拖尾 ( tail )、查詢 ( query ) 和 JSON 或純文字日誌檔案攝取 ( ingest ) 等等。

入門

適用於 Windows 的 Seq 安裝程式包括seqcli 。否則，請下載適合您的作業系統的版本。或者，如果您安裝了dotnet ，則可以使用下列命令將seqcli安裝為全域工具：

 dotnet tool install --global seqcli

若要設定預設伺服器 URL 和 API 金鑰，請執行：

 seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key

API金鑰將儲存在您的SeqCli.json設定檔中；在 Windows 上，這是使用 DPAPI 加密的；在 Mac/Linux 上，金鑰目前以純文字形式儲存。作為在配置中儲存 API 金鑰的替代方法，可以透過--apikey=參數將其傳遞給每個命令。

seqcli也可以當作datalust/seqcli下的 Docker 容器使用：

 docker run --rm datalust/seqcli:latest <command> [<args>]

若要連接至本機上 docker 容器中的 Seq，請使用電腦的 IP 位址（而非 localhost）或使用--net host指定 docker 主機網路。

使用 Docker 網路和磁碟區使本機檔案和其他容器可供seqcli在其容器內存取。

環境變數覆蓋

每個設定值都可以在運行時透過指定SEQCLI_<setting path>形式的環境變數來覆蓋，其中設定名稱的每個點部分包含一個元素，並用下劃線分隔。

例如，設定connection.serverUrl可以用SEQCLI_CONNECTION_SERVERURL變數覆蓋。

無需 API 金鑰即可連接

如果您要自動化 Seq 設置，那麼您很可能還沒有可供seqcli使用的 API 金鑰。在初始Seq伺服器設定期間，您可以指定firstRun.adminUsername和firstRun.adminPasswordHash （或等效的環境變數SEQ_FIRSTRUN_ADMINUSERNAME和SEQ_FIRSTRUN_ADMINPASSWORDHASH ）來設定管理員帳號的初始使用者名稱和密碼。您可以使用它們建立 API 金鑰，然後將 API 金鑰令牌與其餘seqcli命令一起使用。

seqcli apikey create指令接受--connect-username和--connect-password-stdin ，並將新的 API 金鑰令牌列印到STDOUT （以下使用 PowerShell 語法）：

 $user = "admin"
$pw = "thepassword"
$token = (
  echo $pw |
  seqcli apikey create `
    -t CLI `
    --permissions="Read,Write,Project,Organization,System" `
    --connect-username $user --connect-password-stdin
)

貢獻

請參閱CONTRIBUTING.md 。

權限

使用 API 金鑰連接時，允許的操作由指派給該 API 金鑰的權限決定。

若要確定指令所需的權限，請檢查等效伺服器 API 操作的「權限需求」欄位。例如，指令apikey create使用POST api/apikeys端點，這需要Write權限。

用法

所有seqcli指令都遵循相同的模式：

 seqcli <command> [<args>]

命令幫助

可以透過執行以下命令查看支援的命令的完整清單：

 seqcli help

若要顯示特定指令的使用訊息，請執行seqcli help <command> ，例如：

 seqcli help apikey create

這也適用於指揮組；若要列出所有apikey子命令，請執行：

 seqcli help apikey

可用指令

• apikey
  • apikey create — 建立用於自動化或攝取的 API 金鑰。
  • apikey list — 列出可用的 API 金鑰。
  • apikey remove — 從伺服器中刪除 API 金鑰。
  • apikey update — 更新現有的 API 金鑰。
• app
  • app define — 為 .NET [SeqApp]插件產生應用程式定義。
  • app install — 安裝應用程式套件。
  • app list — 列出已安裝的應用程式套件。
  • app run — 託管 .NET [SeqApp]插件。
  • app uninstall — 卸載應用程式套件。
  • app update — 更新已安裝的應用程式套件。
• appinstance
  • appinstance create — 建立已安裝應用程式的實例。
  • appinstance list — 列出已安裝應用程式的實例。
  • appinstance remove — 從伺服器中刪除應用程式實例。
  • appinstance update — 更新現有應用程式實例。
• bench — 衡量查詢效能。
• config — 檢視並設定SeqCli.json檔案中的欄位；不帶參數運行以列出所有欄位。
• dashboard
  • dashboard list — 列出儀表板。
  • dashboard remove — 從伺服器中刪除儀表板。
  • dashboard render — 從儀表板圖表產生 CSV 或 JSON 結果集。
• expressionindex
  • expressionindex create — 建立表達式索引。
  • expressionindex list — 列出表達式索引。
  • expressionindex remove — 從伺服器中刪除表達式索引。
• feed
  • feed create — 建立 NuGet feed。
  • feed list — 列出 NuGet feed。
  • feed remove — 從伺服器中刪除 NuGet feed。
  • feed update — 更新現有的 NuGet feed。
• help — 顯示可用指令的資訊。
• index
  • index list — 列出索引。
  • index suppress — 抑制索引。
• ingest - 從檔案或STDIN傳送日誌事件。
• license apply — 將許可證應用於 Seq 伺服器。
• log — 將結構化日誌事件傳送到伺服器。
• node
  • node demote — 開始降級目前領導節點。
  • node health — 探測 Seq 節點的/health端點，並列印傳回的 HTTP 狀態碼，如果無法查詢端點，則列印「無法存取」。
  • node list — 列出 Seq 叢集中的節點。
• print - 來自檔案或STDIN CLEF/JSON 格式的漂亮列印事件。
• profile
  • profile create — 建立或取代連線設定檔。
  • profile list — 列出連線設定檔。
  • profile remove — 刪除連線設定檔。
• query — 執行 SQL 查詢並接收 CSV 格式的結果。
• retention
  • retention create — 建立保留策略。
  • retention list — 列出保留策略。
  • retention remove — 從伺服器中刪除保留原則。
  • retention update — 更新現有保留策略。
• sample
  • sample ingest - 將樣本事件記錄到 Seq 實例中。
  • sample setup - 使用範例儀表板、訊號、使用者等配置 Seq 實例。
• search — 檢索與給定篩選器相符的日誌事件。
• setting
  • setting clear — 清除運行時可設定的伺服器設定。
  • setting names — 列印所有支援的設定的名稱。
  • setting set — 變更運行時可設定的伺服器設定。
  • setting show — 列印運作時可設定伺服器設定的目前值。
• signal
  • signal create — 建立訊號。
  • signal import — 以換行符號分隔的 JSON 格式匯入訊號。
  • signal list — 列出可用訊號。
  • signal remove — 從伺服器中刪除訊號。
  • signal update — 更新現有訊號。
• tail — 與篩選器相符的流程日誌事件。
• template
  • template export — 將實體匯出到範本文件中。
  • template import — 從範本檔案匯入實體。
• user
  • user create — 建立使用者。
  • user list — 列出使用者。
  • user remove — 從伺服器中刪除使用者。
  • user update — 更新現有使用者。
• version — 列印目前可執行版本。
• workspace
  • workspace create — 建立工作區。
  • workspace list — 列出可用的工作區。
  • workspace remove — 從伺服器中刪除工作區。
  • workspace update — 更新現有工作區。

apikey create

建立用於自動化或攝取的 API 金鑰。

例子：

 seqcli apikey create -t 'Test API Key' -p Environment=Test

選項	描述
-t , --title=VALUE	API 金鑰的標題
--token=VALUE	預先分配的 API 金鑰令牌；預設情況下，將產生一個新令牌並將其寫入STDOUT
-p , --property=NAME=VALUE	指定名稱/值屬性，例如-p Customer=C123 -p Environment=Production
--filter=VALUE	應用於傳入事件的過濾器
--minimum-level=VALUE	可接受的最低事件等級/嚴重性；預設是接受所有事件
--use-server-timestamps	丟棄客戶端提供的時間戳記並使用伺服器時鐘值
--permissions=VALUE	以逗號分隔的權限列表，委託給 API 金鑰；有效權限為Ingest （預設）、 Read 、 Write 、 Project和System
--connect-username=VALUE	用於連接的用戶名，主要在設定第一個 API 金鑰時有用；具有“個人”訂閱的伺服器僅允許使用此選項的一個同時請求
--connect-password=VALUE	當指定connect-username時，對應的密碼
--connect-password-stdin	當指定connect-username時，從STDIN讀取對應的密碼
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）

apikey list

列出可用的 API 金鑰。

例子：

 seqcli apikey list

選項	描述
-t , --title=VALUE	要列出的 API 金鑰的標題
-i , --id=VALUE	要列出的單一 API 金鑰的 ID
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

apikey remove

從伺服器中刪除 API 金鑰。

例子：

 seqcli apikey remove -t 'Test API Key'

選項	描述
-t , --title=VALUE	要刪除的 API 金鑰的標題
-i , --id=VALUE	要刪除的單一 API 金鑰的 ID
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

apikey update

更新現有的 API 金鑰。

例子：

 seqcli apikey update --json '{...}'

選項	描述
--json=VALUE	更新後的 JSON 格式的 API 金鑰；這可以使用seqcli apikey list --json生成
--json-stdin	從STDIN讀取更新後的 JSON 格式的 API 金鑰
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

app define

為 .NET [SeqApp]插件產生應用程式定義。

例子：

 seqcli app define -d "./bin/Debug/netstandard2.2"

選項	描述
-d , --directory=VALUE	包含 .NET Standard 程序集的目錄；預設為當前目錄
--type=VALUE	[SeqApp]插件類型名稱；預設掃描程序集以尋找標有此屬性的單一類型
--indented	使用縮排設定多行定義的格式

app install

安裝應用程式套件。

例子：

 seqcli app install --package-id 'Seq.App.JsonArchive'

選項	描述
--package-id=VALUE	要安裝的應用程式的套件 ID
--version=VALUE	要安裝的軟體包版本；預設安裝最新版本
--feed-id=VALUE	用於安裝套件的 NuGet feed 的 id；如果只配置了一個 feed，則可以省略
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）

app list

列出已安裝的應用程式包。

例子：

 seqcli app list

選項	描述
--package-id=VALUE	要列出的應用程式的套件 ID
-i , --id=VALUE	要列出的單一應用程式的 ID
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

app run

託管 .NET [SeqApp]插件。

例子：

 seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]

選項	描述
-d , --directory=VALUE	包含 .NET Standard 程序集的目錄；預設為當前目錄
--type=VALUE	[SeqApp]插件類型名稱；預設掃描程序集以尋找標有此屬性的單一類型
-p , --property=NAME=VALUE	指定應用程式的名稱/值設置，例如-p [email protected] -p Subject="Alert!"
--storage=VALUE	可以儲存應用程式特定資料的目錄；預設為當前目錄
-s , --server=VALUE	Seq伺服器的URL，僅用於應用程式配置（不連接到伺服器）；預設將使用connection.serverUrl值
--server-instance=VALUE	Seq伺服器的實例名稱，僅用於應用程式配置；預設沒有實例名稱
-t , --title=VALUE	應用實例標題，僅用於應用配置；預設為佔位符標題。
--id=VALUE	應用實例id，僅用於應用程式配置；預設為佔位符 id。
--read-env	從環境變數中讀取應用程式配置和設置，如 https://docs.datalust.co/docs/seq-apps-in-other-languages 中指定的；忽略除 --directory 和 --type 之外的所有選項

app uninstall

卸載應用程式包。

例子：

 seqcli app uninstall --package-id 'Seq.App.JsonArchive'

選項	描述
--package-id=VALUE	要卸載的應用程式包的包id
-i , --id=VALUE	待卸載的單一應用程式包id
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

app update

更新已安裝的應用程式套件。

例子：

 seqcli app update -n 'HTML Email'

選項	描述
-i , --id=VALUE	要更新的單一已安裝應用程式的 ID
-n ， --name=VALUE	要更新的已安裝應用程式的名稱
--all	更新所有已安裝的應用程式；與-i或-n不相容
--version=VALUE	要更新到的軟體包版本；預設是更新到關聯 feed 中的最新版本
--force	即使目標版本已安裝，也更新應用程式
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）

appinstance create

建立已安裝應用程式的實例。

例子：

 seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]

選項	描述
-t , --title=VALUE	應用程式實例的標題
--app=VALUE	要實例化的已安裝應用包的id
-p , --property=NAME=VALUE	指定應用程式的名稱/值設置，例如-p [email protected] -p Subject="Alert!"
--stream[=VALUE]	在攝取傳入事件時將其串流傳輸到此應用程式實例；可選擇接受限制應串流哪些事件的訊號表達式，例如signal-1,signal-2
--overridable=VALUE	指定呼叫應用程式時使用者可能會覆蓋的設定名稱
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）

appinstance list

列出已安裝應用程式的實例。

例子：

 seqcli appinstance list

選項	描述
-t , --title=VALUE	要列出的應用程式實例的標題
-i , --id=VALUE	要列出的單一應用程式實例的 ID
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

appinstance remove

從伺服器中刪除應用程式實例。

例子：

 seqcli appinstance remove -t 'Email Ops'

選項	描述
-t , --title=VALUE	要刪除的應用程式實例的標題
-i , --id=VALUE	要刪除的單一應用程式實例的 id
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

appinstance update

更新現有應用程式實例。

例子：

 seqcli appinstance update --json '{...}'

選項	描述
--json=VALUE	JSON格式的更新後的應用程式實例；這可以使用seqcli appinstance list --json生成
--json-stdin	從STDIN以 JSON 形式讀取更新的應用程式實例
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

bench

衡量查詢效能。

選項	描述
-r , --runs=VALUE	要執行的運行次數；預設值為 10
-c , --cases=VALUE	包含要運行的案例集的 JSON 檔案。預設為一組標準案例。
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值
--start=VALUE	查詢的 ISO 8601 日期/時間
--end=VALUE	要查詢的 ISO 8601 日期/時間
--reporting-server=VALUE	將基準結果傳送到的 Seq 伺服器的位址
--reporting-apikey=VALUE	連接到報告伺服器時使用的 API 金鑰
--description=VALUE	台架測試運行的可選描述
--with-ingestion	基準測試是否應該包括將事件傳送到 Seq
--with-queries	基準測試是否應該包括查詢 Seq

config

查看和設定SeqCli.json文件中的字段；不帶參數運行以列出所有欄位。

選項	描述
-k , --key=VALUE	該字段，例如connection.serverUrl
-v , --value=VALUE	字段值；如果未指定，該命令將列印目前值
-c , --clear	清除字段

dashboard list

列出儀表板。

例子：

 seqcli dashboard list

選項	描述
-t , --title=VALUE	要列出的儀表板的標題
-i , --id=VALUE	要列出的單一儀表板的 ID
-o , --owner=VALUE	為其列出儀表板的使用者 ID；預設情況下，列出共享儀表板
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

dashboard remove

從伺服器中刪除儀表板。

例子：

 seqcli dashboard remove -i dashboard-159

選項	描述
-t , --title=VALUE	要刪除的儀表板的標題
-i , --id=VALUE	要刪除的單一儀表板的 ID
-o , --owner=VALUE	要刪除儀表板的使用者的 ID；預設情況下，共享儀表板被刪除
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

dashboard render

從儀表板圖表產生 CSV 或 JSON 結果集。

例子：

 seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h

選項	描述
-i , --id=VALUE	要呈現的單一儀表板的 ID
-c , --chart=VALUE	儀表板上要呈現的圖表的標題
--last=VALUE	圖表渲染的持續時間，例如7d ；這將與間隔邊界對齊；必須指定--last或--start和--end
--by=VALUE	圖表資料的時間片間隔，作為持續時間，例如1h
--start=VALUE	查詢的 ISO 8601 日期/時間
--end=VALUE	要查詢的 ISO 8601 日期/時間
--signal=VALUE	要套用的訊號表達式或相交訊號 ID 列表，例如signal-1,signal-2
--timeout=VALUE	執行超時（以毫秒為單位）
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設將使用connection.serverUrl和connection.apiKey配置值

expressionindex create

建立表達式索引。

例子：

 seqcli expressionindex create --expression "ServerName"

選項	描述
-e , --expression=VALUE	要索引的表達式
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設將使用connection.serverUrl和connection.apiKey配置值
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）

expressionindex list

列出表達式索引。

例子：

 seqcli expressionindex list

選項	描述
-i , --id=VALUE	要列出的單一表達式索引的 id
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

expressionindex remove

從伺服器中刪除表達式索引。

例子：

 seqcli expressionindex -i expressionindex-2529

選項	描述
-i , --id=VALUE	要刪除的表達式索引的 id
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

feed create

建立 NuGet 來源。

例子：

 seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin

選項	描述
-n ， --name=VALUE	Feed 的唯一名稱
-l , --location=VALUE	進料位置；這可能是 NuGet v2 或 v3 feed URL，或是 Seq 伺服器上的本機檔案系統路徑
-u , --username=VALUE	如果需要身份驗證，則連接到 feed 時應提供使用者名稱 Seq
-p , --password=VALUE	提要密碼（如果需要身份驗證）；請注意--password-stdin更安全
--password-stdin	從STDIN讀取 feed 密碼
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設將使用connection.serverUrl和connection.apiKey配置值
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）

feed list

列出 NuGet 來源。

例子：

 seqcli feed list

選項	描述
-n , --name=VALUE	要列出的 feed 的名稱
-i , --id=VALUE	要列出的單一提要的 ID
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

feed remove

從伺服器中刪除 NuGet 來源。

例子：

 seqcli feed remove -n CI

選項	描述
-n ， --name=VALUE	要刪除的 Feed 的名稱
-i , --id=VALUE	要刪除的單一 feed 的 ID
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

feed update

更新現有的 NuGet 來源。

例子：

 seqcli feed update --json '{...}'

選項	描述
--json=VALUE	更新後的 JSON 格式的 NuGet feed；這可以使用seqcli feed list --json生成
--json-stdin	從STDIN讀取更新後的 NuGet feed 作為 JSON
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

help

顯示有​​關可用命令的資訊。

例子：

 seqcli help search

選項	描述
-m , --markdown	產生用於文件的 Markdown

index list

列出索引。

例子：

 seqcli index list

選項	描述
-i , --id=VALUE	要列出的單一索引的 id
--json	以換行符號分隔的 JSON 格式列印輸出（預設為純文字）
--no-color	不要對文字輸出著色
--force-color	強制重定向輸出具有 ANSI 顏色（除非也指定了--no-color ）
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

index suppress

抑制索引。

例子：

 seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748

選項	描述
-i , --id=VALUE	要抑制的索引的 id
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值

ingest

從檔案或STDIN傳送日誌事件。

例子：

 seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test

選項	描述
-i ， --input=VALUE	要攝取的文件，包括*通配符；如果未指定，將使用STDIN
--invalid-data=VALUE	指定如何處理無效資料： fail （預設）或ignore
-p , --property=NAME=VALUE	指定名稱/值屬性，例如-p Customer=C123 -p Environment=Production
-x , --extract=VALUE	應用於純文字日誌的擷取模式（指定--json時忽略）
--json	以 JSON 形式讀取事件（預設為純文字）
-f , --filter=VALUE	過濾表達式以選擇事件子集
-m , --message=VALUE	與攝取事件相關聯的訊息；支援 https://messagetemplates.org 語法
-l , --level=VALUE	與攝入事件相關的等級或嚴重性；這將覆蓋事件本身中存在的任何級別訊息
--send-failure=VALUE	指定如何處理連線失敗： fail （預設）、 retry 、 continue或ignore
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下，將使用connection.serverUrl和connection.apiKey配置值
--batch-size=VALUE	每個請求中傳送到攝取端點的最大事件數；如果未指定，將使用值100

license apply

將許可證應用於 Seq 伺服器。

例子：

 seqcli license apply --certificate="license.txt"

選項	描述
-c , --certificate=VALUE	證書文件；文件必須是 UTF-8 文本
--certificate-stdin	從STDIN讀取許可證書
--automatically-refresh	如果許可證用於訂閱，請定期檢查datalust.co並在訂閱更改或續訂時自動刷新證書
-s , --server=VALUE	Seq伺服器的URL；預設將使用connection.serverUrl配置值
-a , --apikey=VALUE	連接到伺服器時使用的 API 金鑰；預設將使用connection.apiKey配置值
--profile=VALUE	要使用的連接設定檔；預設情況下， connection.serverUrl和connection.apiKey配置值將是我們