Skip to main content

If you are using our backend SDK that is lesser than the following versions, please visit the older documentation link here.

CLI Overview

The SuperTokens CLI has the following general syntax:

supertokens [command] [--help] [--version]
  • supertokens --help: The help command
  • supertokens --version: Displays the version of the various installed components.
important

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

Commands#

Start#

  • supertokens start [options]
  • Start an instance of SuperTokens.

List running instances#

  • supertokens list
  • List information about all currently running SuperTokens instances.

Stop#

  • supertokens stop [options]
  • Stops all (if no options are provided) or one specific instance of SuperTokens.

Uninstall#

  • supertokens uninstall
  • Uninstalls SuperTokens.
Looking for older versions of the documentation?
Which UI do you use?
Custom UI
Pre built UI