Skip to main content

SuperTokens CLI

Overview

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

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

If you are using Windows, you can only use the SuperTokens CLI using a terminal with Administrator privilege.

Commands

Start

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

supertokens start [options]

Options

OptionDescriptionExample
--with-spaceSets the amount of space, in MB, to allocate to the JVM.supertokens start --with-space=200 allocates 200MB for the JVM
--with-configSpecify the location of the configuration file to load. Can be either relative or absolute.supertokens start --with-config=/usr/config.yaml
--portSets the port on which this instance of SuperTokens should run.supertokens start --port=8080
--hostSets the host on which this instance of SuperTokens should run.supertokens start --host=192.168.0.1
--foregroundRuns this instance of SuperTokens in the foreground (not as a daemon).supertokens start --foreground
--helpHelp for this command.supertokens start --help

List

List information about all running SuperTokens instances.

supertokens list [options]

Stop

supertokens stop [options]

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

Options

OptionDescriptionExample
--idStop 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
--helpHelp for this command.supertokens stop --help

Uninstall

Uninstalls SuperTokens

supertokens uninstall [options]

Manual uninstall

1. Stop or kill all SuperTokens processes
supertokens stop
2. Delete the installation directory

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

3. Delete the SuperTokens script
  • Linux: /usr/bin/supertokens
  • Mac: /usr/local/bin/supertokens
  • Windows: C:\Windows\System32\supertokens.bat