You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[`config`](#config)— View and set fields in the `SeqCli.json` file; run with no arguments to list all fields.
84
89
-`dashboard`
85
-
-[`dashboard list`](#dashboard-list)— List dashboards.
86
-
-[`dashboard remove`](#dashboard-remove)— Remove a dashboard from the server.
87
-
-[`dashboard render`](#dashboard-render)— Produce a CSV or JSON result set from a dashboard chart.
90
+
-[`dashboard list`](#dashboard-list)— List dashboards.
91
+
-[`dashboard remove`](#dashboard-remove)— Remove a dashboard from the server.
92
+
-[`dashboard render`](#dashboard-render)— Produce a CSV or JSON result set from a dashboard chart.
88
93
-`feed`
89
-
-[`feed create`](#feed-create)— Create a NuGet feed.
90
-
-[`feed list`](#feed-list)— List NuGet feeds.
91
-
-[`feed remove`](#feed-remove)— Remove a NuGet feed from the server.
94
+
-[`feed create`](#feed-create)— Create a NuGet feed.
95
+
-[`feed list`](#feed-list)— List NuGet feeds.
96
+
-[`feed remove`](#feed-remove)— Remove a NuGet feed from the server.
92
97
-[`help`](#help)— Show information about available commands.
93
98
-[`ingest`](#ingest)— Send log events from a file or `STDIN`.
94
99
-[`license apply`](#license-apply)— Apply a license to the Seq server.
95
100
-[`log`](#log)— Send a structured log event to the server.
96
101
-`node`
97
-
-[`node demote`](#node-demote)— Begin demotion of the current leader node.
98
-
-[`node health`](#node-health)— Probe a Seq node's `/health` endpoint, and print the returned HTTP status code, or 'Unreachable' if the endpoint could not be queried.
99
-
-[`node list`](#node-list)— List nodes in the Seq cluster.
102
+
-[`node demote`](#node-demote)— Begin demotion of the current leader node.
103
+
-[`node health`](#node-health)— Probe a Seq node's `/health` endpoint, and print the returned HTTP status code, or 'Unreachable' if the endpoint could not be queried.
104
+
-[`node list`](#node-list)— List nodes in the Seq cluster.
100
105
-[`print`](#print)— Pretty-print events in CLEF/JSON format, from a file or `STDIN`.
101
106
-`profile`
102
-
-[`profile create`](#profile-create)— Create or replace a connection profile.
103
-
-[`profile list`](#profile-list)— List connection profiles.
104
-
-[`profile remove`](#profile-remove)— Remove a connection profile.
107
+
-[`profile create`](#profile-create)— Create or replace a connection profile.
108
+
-[`profile list`](#profile-list)— List connection profiles.
109
+
-[`profile remove`](#profile-remove)— Remove a connection profile.
105
110
-[`query`](#query)— Execute an SQL query and receive results in CSV format.
106
111
-`retention`
107
-
-[`retention create`](#retention-create)— Create a retention policy.
108
-
-[`retention list`](#retention-list)— List retention policies.
109
-
-[`retention remove`](#retention-remove)— Remove a retention policy from the server.
112
+
-[`retention create`](#retention-create)— Create a retention policy.
113
+
-[`retention list`](#retention-list)— List retention policies.
114
+
-[`retention remove`](#retention-remove)— Remove a retention policy from the server.
110
115
-`sample`
111
-
-[`sample ingest`](#sample-ingest)— Log sample events into a Seq instance.
112
-
-[`sample setup`](#sample-setup)— Configure a Seq instance with sample dashboards, signals, users, and so on.
116
+
-[`sample ingest`](#sample-ingest)— Log sample events into a Seq instance.
117
+
-[`sample setup`](#sample-setup)— Configure a Seq instance with sample dashboards, signals, users, and so on.
113
118
-[`search`](#search)— Retrieve log events that match a given filter.
119
+
-`setting`
120
+
-[`setting clear`](#setting-clear)— Clear a runtime-configurable server setting.
121
+
-[`setting names`](#setting-names)— Print the names of all supported settings.
122
+
-[`setting set`](#setting-set)— Change a runtime-configurable server setting.
123
+
-[`setting show`](#setting-show)— Print the current value of a runtime-configurable server setting.
114
124
-`signal`
115
-
-[`signal create`](#signal-create)— Create a signal.
116
-
-[`signal import`](#signal-import)— Import signals in newline-delimited JSON format.
117
-
-[`signal list`](#signal-list)— List available signals.
118
-
-[`signal remove`](#signal-remove)— Remove a signal from the server.
125
+
-[`signal create`](#signal-create)— Create a signal.
126
+
-[`signal import`](#signal-import)— Import signals in newline-delimited JSON format.
127
+
-[`signal list`](#signal-list)— List available signals.
128
+
-[`signal remove`](#signal-remove)— Remove a signal from the server.
119
129
-[`tail`](#tail)— Stream log events matching a filter.
120
130
-`template`
121
-
-[`template export`](#template-export)— Export entities into template files.
122
-
-[`template import`](#template-import)— Import entities from template files.
131
+
-[`template export`](#template-export)— Export entities into template files.
132
+
-[`template import`](#template-import)— Import entities from template files.
123
133
-`user`
124
-
-[`user create`](#user-create)— Create a user.
125
-
-[`user list`](#user-list)— List users.
126
-
-[`user remove`](#user-remove)— Remove a user from the server.
134
+
-[`user create`](#user-create)— Create a user.
135
+
-[`user list`](#user-list)— List users.
136
+
-[`user remove`](#user-remove)— Remove a user from the server.
127
137
-[`version`](#version)— Print the current executable version.
128
138
-`workspace`
129
-
-[`workspace create`](#workspace-create)— Create a workspace.
130
-
-[`workspace list`](#workspace-list)— List available workspaces.
131
-
-[`workspace remove`](#workspace-remove)— Remove a workspace from the server.
139
+
-[`workspace create`](#workspace-create)— Create a workspace.
140
+
-[`workspace list`](#workspace-list)— List available workspaces.
141
+
-[`workspace remove`](#workspace-remove)— Remove a workspace from the server.
|`-t`, `--title=VALUE`| A title for the app instance |
329
+
|`--app=VALUE`| The id of the installed app package to instantiate |
330
+
|`-p`, `--property=NAME=VALUE`| Specify name/value settings for the app, e.g. `-p [email protected] -p Subject="Alert!"`|
331
+
|`--stream[=VALUE]`| Stream incoming events to this app instance as they're ingested; optionally accepts a signal expression limiting which events should be streamed |
332
+
|`--overridable=VALUE`| Specify setting names that may be overridden by users when invoking the app |
333
+
|`-s`, `--server=VALUE`| The URL of the Seq server; by default the `connection.serverUrl` config value will be used |
334
+
|`-a`, `--apikey=VALUE`| The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used |
335
+
|`--profile=VALUE`| A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used |
336
+
|`--json`| Print output in newline-delimited JSON (the default is plain text) |
337
+
|`--no-color`| Don't colorize text output |
338
+
|`--force-color`| Force redirected output to have ANSI color (unless `--no-color` is also specified) |
339
+
340
+
### `appinstance list`
341
+
342
+
List instances of installed apps.
343
+
344
+
Example:
345
+
346
+
```
347
+
seqcli appinstance list
348
+
```
349
+
350
+
| Option | Description |
351
+
| ------ | ----------- |
352
+
|`-t`, `--title=VALUE`| The title of the app instance(s) to list |
353
+
|`-i`, `--id=VALUE`| The id of a single app instance to list |
354
+
|`--json`| Print output in newline-delimited JSON (the default is plain text) |
355
+
|`--no-color`| Don't colorize text output |
356
+
|`--force-color`| Force redirected output to have ANSI color (unless `--no-color` is also specified) |
357
+
|`-s`, `--server=VALUE`| The URL of the Seq server; by default the `connection.serverUrl` config value will be used |
358
+
|`-a`, `--apikey=VALUE`| The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used |
359
+
|`--profile=VALUE`| A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used |
360
+
361
+
### `appinstance remove`
362
+
363
+
Remove an app instance from the server.
364
+
365
+
Example:
366
+
367
+
```
368
+
seqcli appinstance remove -t 'Email Ops'
369
+
```
370
+
371
+
| Option | Description |
372
+
| ------ | ----------- |
373
+
|`-t`, `--title=VALUE`| The title of the app instance(s) to remove |
374
+
|`-i`, `--id=VALUE`| The id of a single app instance to remove |
375
+
|`-s`, `--server=VALUE`| The URL of the Seq server; by default the `connection.serverUrl` config value will be used |
376
+
|`-a`, `--apikey=VALUE`| The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used |
377
+
|`--profile=VALUE`| A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used |
378
+
285
379
### `bench`
286
380
287
381
Measure query performance.
288
382
289
383
| Option | Description |
290
384
| ------ | ----------- |
291
-
|`-r`, `--runs=VALUE`| The number of runs to execute |
385
+
|`-r`, `--runs=VALUE`| The number of runs to execute; the default is 10|
292
386
|`-c`, `--cases=VALUE`| A JSON file containing the set of cases to run. Defaults to a standard set of cases. |
293
387
|`-s`, `--server=VALUE`| The URL of the Seq server; by default the `connection.serverUrl` config value will be used |
294
388
|`-a`, `--apikey=VALUE`| The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used |
@@ -297,6 +391,9 @@ Measure query performance.
297
391
|`--end=VALUE`| ISO 8601 date/time to query to |
298
392
|`--reporting-server=VALUE`| The address of a Seq server to send bench results to |
299
393
|`--reporting-apikey=VALUE`| The API key to use when connecting to the reporting server |
394
+
|`--description=VALUE`| Optional description of the bench test run |
395
+
|`--with-ingestion`| Should the benchmark include sending events to Seq |
396
+
|`--with-queries`| Should the benchmark include querying Seq |
|`--after=VALUE`| A duration after which the policy will delete events, e.g. `7d`|
672
769
|`--delete-all-events`| The policy should delete all events (currently the only supported option) |
770
+
|`--delete=VALUE`| Stream incoming events to this app instance as they're ingested; optionally accepts a signal expression limiting which events should be streamed |
673
771
|`-s`, `--server=VALUE`| The URL of the Seq server; by default the `connection.serverUrl` config value will be used |
674
772
|`-a`, `--apikey=VALUE`| The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used |
675
773
|`--profile=VALUE`| A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used |
0 commit comments