DocumentationDiscussions
DocumentationDiscussions
Hey! These docs are for version 4.2, which is no longer officially supported. Click here for the latest version, 2022.1!

Server Command Line

The seq.exe executable has an extensive command line for performing administration tasks.

Usage

Syntax:

seq <command> [<args>]

Available commands are:

CommandDescription
auth Change authentication provider
backup Write a backup of the Seq configuration and metadata
bind-ssl Bind an installed SSL certificate to an HTTPS port served by Seq
browse Open a web browser at the address configured for the Seq instance
compact Release empty space in the event store
config View and set fields in the Seq.json file; run with no arguments to list all fields
help Show information about available commands
install Install the Seq server as a Windows service
list List Seq instances installed on the machine
restart Restart the Windows service
restore Restore from a backup of the Seq configuration and metadata
run Host the server in the current process
show-key Print the master encryption key used to protect backup files
start Start the Windows service
status Show the status of the Seq service
stop Stop the Windows service
uninstall Uninstall the Seq Windows service
unlock Reset a user's password
version Print the current executable version

Type seq help <command> for detailed help.

Commands

auth

Change authentication provider.

OptionDescription
--basicSwitch to basic username/password authentication; must be specified in conjunction with new credentials for an administrative account
-u, --username=VALUEThe name of the user account
-p, --password=VALUEThe password for the user account
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.

backup

Write a backup of the Seq configuration and metadata.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.
-p, --path=VALUEThe folder path where the backup file should be stored (default: current directory)

bind-ssl

Bind an installed SSL certificate to an HTTPS port served by Seq. Windows only.

OptionDescription
--port=VALUEThe port on which the Seq server is listening (default is 443)
--thumbprint=VALUEThe thumbprint of the SSL certificate to bind; this can be found with the Manage computer certificates program
--hostname=VALUEIf SNI is used, the specific host name to bind to (default is to bind to all hostnames via the IP address)

browse

Open a web browser at the address configured for the Seq instance.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.

compact

Release empty space in the event store.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.
--repairAttempt to repair extents that cannot be compacted cleanly

config

View and set fields in the Seq.json file; run with no arguments to list all fields.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.
-k, --key=VALUEThe field, for example "api.listenUris"
-v, --value=VALUEThe field value, comma-separated if multiple values are accepted; if not specified, the command will print the current value
-c, --clearClear the field

help

Show information about available commands.

Example:

seq help config

install

Install the Seq server as a Windows service. Windows only.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.
-l, --listen=VALUESet the URL(s) to listen on; the default is 'http://localhost:5341'
--ram-target=VALUESets the system memory consumption target that Seq will use to determine utilization, in percent. The default is 90.
-u, --username=VALUEThe name of a Windows account to run the service under; if not specified the Local System account will be used
-p, --password=VALUEThe password for the Windows account to run the service under
--setupInstall and start the service only if it does not exist; otherwise reconfigure the binary location

list

List Seq instances installed on the machine.

restart

Restart the Windows service. Windows only.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance

restore

Restore from a backup of the Seq configuration and metadata.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.
-k, --master-key=VALUEThe base-64 encoded master encryption key (enclose in double quotes to escape embedded equals signs)
-b, --backup=VALUEThe .seqbac file to restore from; this must have been created with the exact Seq version in use

run

Host the server in the current process.

OptionDescription
--nologo
--interactive
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.

show-key

Print the master encryption key used to protect backup files.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.

start

Start the Windows service. Windows only.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance

status

Show the status of the Seq service.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance

stop

Stop the Windows service. Windows only.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance

uninstall

Uninstall the Seq Windows service. Windows only.

OptionDescription
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance

unlock

Reset a user's password.

OptionDescription
-u, --username=VALUEThe name of the user account
-p, --password=VALUEThe password for the user account
-n, --name=VALUEIf multiple Seq instances are in use, the name of the instance
-s, --storage=VALUESpecify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default.
--require-changeRequire a password change next time the user logs in

version

Print the current executable version.


Did this page help you?