CLI

Learn to use SuperTokens CLI for starting, listing, stopping, and uninstalling instances.

Overview

The SuperTokens CLI has the allows you to manage your core instance from the command line.

supertokens [command] [--help] [--version]

Start an instance of SuperTokens. By default, the process starts as a daemon.

supertokens start [options]

Option	Description	Example
`--with-space`	Sets the amount of space, in MB, to allocate to the `JVM`.	`supertokens start --with-space=200` allocates 200MB for the `JVM`
`--with-config`	Specify the location of the configuration file to load. Can be either relative or absolute.	`supertokens start --with-config=/usr/config.yaml`
`--port`	Sets the port on which this instance of SuperTokens should run.	`supertokens start --port=8080`
`--host`	Sets the host on which this instance of SuperTokens should run.	`supertokens start --host=192.168.0.1`
`--foreground`	Runs this instance of SuperTokens in the foreground (not as a daemon).	`supertokens start --foreground`
`--help`	Help for this command.	`supertokens start --help`

List information about all running SuperTokens instances.

supertokens list [options]

supertokens stop [options]

If you do not provide options, the command stops all instances, or it stops one specific instance of SuperTokens.

Option	Description	Example
`--id`	Stop an instance of SuperTokens that has a specific `PID`. You can obtain an instance’s `PID` via the `supertokens list` command.	`supertokens stop --id=7634`
`--help`	Help for this command.	`supertokens stop --help`

Uninstalls SuperTokens

supertokens uninstall [options]

supertokens stop

You can find out the installation directory by running supertokens --help.