Show table of contents Hide table of contents

Platform:

Server Command Line

Usage

Syntax:

seq <command> [<args>]

Available commands are:

Command Description
auth reset Switch to local username/password authentication and set new credentials for an administrative account
auth show Describe the current authentication provider and list active user accounts
backup Write a backup of the Seq configuration and metadata
browse Open a web browser on the Seq user interface
config clear Clear fields in the Seq.json file
config create Create a default Seq.json file, if none exists
config get View a field from the Seq.json file
config hash Read a password from STDIN and print a salted, Base64 encoded cryptographic hash of the password that is suitable for storing in configuration fields (leading and trailing whitespace will be trimmed)
config list View all fields in the Seq.json file
config set Set a field in the Seq.json file
help Show information about available commands
metastore to-mssql Reconfigure and move the internal metastore to a Microsoft SQL Server/Azure SQL Database
metastore to-postgresql Reconfigure and move the internal metastore to a PostgreSQL database
node migrate Migrate a legacy DR node to a cluster node.
restore Restore from a backup of the Seq configuration and metadata
run Run the server process
secret clear Remove a configuration field override from the secret store
secret set Override a configuration field by adding a value to the secret store
show-key Print the encryption key ('secret key') used to protect sensitive fields and backup files
version Print the current executable version

Type seq help <command> for detailed help.

Commands

auth reset

Switch to local username/password authentication and set new credentials for an administrative account.

Option Description
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-p, --password=VALUE The password for the user account
--password-stdin Read the new password from STDIN
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.
-u, --username=VALUE The name of the user account

auth show

Describe the current authentication provider and list active user accounts.

Option Description
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

backup

Write a backup of the Seq configuration and metadata.

Option Description
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-p, --path=VALUE The folder path where the backup file should be stored (default: current directory)
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

browse

Open a web browser on the Seq user interface.

Option Description
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

config clear

Clear fields in the Seq.json file.

Option Description
-k, --key=VALUE The field, for example api.listenUris
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

config create

Create a default Seq.json file, if none exists.

Option Description
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

config get

View a field from the Seq.json file.

Option Description
-k, --key=VALUE The field, for example api.listenUris
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

config hash

Read a password from STDIN and print a salted, Base64 encoded cryptographic hash of the password that is suitable for storing in configuration fields (leading and trailing whitespace will be trimmed).

config list

View all fields in the Seq.json file.

Option Description
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

config set

Set a field in the Seq.json file.

Option Description
-k, --key=VALUE The field, for example api.listenUris
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.
-v, --value=VALUE The field value, comma-separated if multiple values are accepted
--value-stdin Read the value from STDIN

help

Show information about available commands.

Example:

seq help config set
Option Description
--pre Show preview commands

metastore to-mssql

Reconfigure and move the internal metastore to a Microsoft SQL Server/Azure SQL Database.

Option Description
-c, --connection-string=VALUE The connection string for the target database
--connection-string-stdin Read the connection string from STDIN
--msi-resource=VALUE If the connection must use an Azure Managed Service Identity, the resource for which to request an access token; normally this will be https://database.windows.net/; the default is to not use an Azure MSI
--msi-tenant-id=VALUE If using an Azure Managed Service Identity and the identity has access to multiple tenants, the tenant id; the default is to not specify a tenant id
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.
--schema=VALUE The schema under which to store metadata; the default is dbo
--skip-config Don't save connection information (useful if the connection string will be supplied in an environment variable once the metastore is moved)

metastore to-postgresql

Reconfigure and move the internal metastore to a PostgreSQL database.

Option Description
-c, --connection-string=VALUE The connection string for the target database
--connection-string-stdin Read the connection string from STDIN
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.
--schema=VALUE The schema under which to store metadata; the default is seq
--skip-config Don't save connection information (useful if the connection string and schema will be supplied an environment variables once the metastore is moved)

node migrate

Migrate a legacy DR node to a cluster node..

Option Description
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

restore

Restore from a backup of the Seq configuration and metadata.

Option Description
-b, --backup=VALUE The .seqbac file to restore from; this must have been created with the exact Seq version in use
--enable-apps Enable streaming events to plug-in Seq apps; by default, apps must be manually re-enabled after restoring
--from-latest Restore the most recent nightly backup on this instance, using the current secret key, and re-enable all apps
-k, --secret-key=VALUE The Base64 encoded encryption key (enclose in double quotes to escape embedded equals signs)
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.
-y, --confirm Assume y for any confirmations

run

Run the server process.

Option Description
--default-admin-password-stdin Read a default password for the first administrator account from STDIN; the password will be requested, but ignored, after the first time Seq is run
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
--nologo
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

secret clear

Remove a configuration field override from the secret store.

Option Description
-k, --key=VALUE The field, for example api.listenUris
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

secret set

Override a configuration field by adding a value to the secret store.

Option Description
-k, --key=VALUE The field, for example api.listenUris
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.
-v, --value=VALUE The field value, comma-separated if multiple values are accepted
--value-stdin Read the value from STDIN

show-key

Print the encryption key ('secret key') used to protect sensitive fields and backup files.

Option Description
--generate Generate and print a new key to use with another Seq instance
-n, --name=VALUE If multiple Seq instances are in use, the name of the instance
-s, --storage=VALUE Specify the folder where data for this instance is stored; /Seq(/Instance/[Name]) is used by default.

version

Print the current executable version.