CLI Overview

This section is only relevant for self-hosted / on premise versions of SuperTokens

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.

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
  • 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.