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=引数を介して各コマンドに API キーを渡すことができます。

seqcli datalust/seqcliの下の Docker コンテナとしても使用できます。

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

ローカル マシン上の Docker コンテナ内の Seq に接続するには、マシンの IP アドレス (localhost ではない) を使用するか、 --net hostで Docker ホスト ネットワークを指定します。

Docker ネットワークとボリュームを使用して、コンテナー内のseqcliローカル ファイルや他のコンテナーにアクセスできるようにします。

環境変数の上書き

各設定値は、 SEQCLI_<setting path>形式の環境変数を指定することで実行時にオーバーライドできます。ここで、 には、アンダースコアで区切られた設定名のドット部分ごとに 1 つの要素が含まれます。

たとえば、 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 list — NuGet フィードをリストします。
  • feed remove — NuGet フィードをサーバーから削除します。
  • feed update — 既存の NuGet フィードを更新します。
• 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 キーを設定するときに役立ちます。 「個人」サブスクリプションを持つサーバーでは、このオプションを使用した同時リクエストは 1 つだけ許可されます
--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	更新された API キーをSTDINから JSON として読み取ります
-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 フィードの ID。フィードが 1 つだけ設定されている場合は省略できます
-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-lungs で指定されているように、環境変数からアプリの構成と設定を読み取ります。 --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	更新するパッケージのバージョン。デフォルトでは、関連するフィードの最新バージョンに更新されます。
--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	フィードの一意の名前
-l 、 --location=VALUE	フィードの場所。これは、NuGet v2 または v3 フィード URL、または Seq サーバー上のローカル ファイルシステム パスである可能性があります。
-u 、 --username=VALUE	認証が必要な場合、フィードに接続するときに Seq が指定するユーザー名
-p 、 --password=VALUE	認証が必要な場合はフィードのパスワード。 --password-stdin方が安全であることに注意してください
--password-stdin	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も指定されていない場合)

feed list

NuGet フィードを一覧表示します。

例：

 seqcli feed list

オプション	説明
-n 、 --name=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構成値が使用されます。

feed remove

NuGet フィードをサーバーから削除します。

例：

 seqcli feed remove -n CI

オプション	説明
-n 、 --name=VALUE	削除するフィードの名前
-i 、 --id=VALUE	削除する単一フィードの 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 フィード。これは、 seqcli feed list --json使用して生成できます。
--json-stdin	更新された NuGet フィードをSTDINから 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	ドキュメントで使用するマークダウンを生成する

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構成値は us になります。