Skip to main content
Version: Next

Usage​

Manage the development stack for this project.

Usage: serverpod runner <subcommand> [arguments]
-h, --help    Print this usage information.

Available subcommands:
  attach   Attach to the development stack already running for this project.
  start    Start the development stack for this project and return, leaving it running in the background.
  status   Print the development stack's state and addresses for this project.
  stop     Stop the development stack running for this project.

Run "serverpod help" to see global options.

Sub commands​

start​

Start the development stack for this project and return, leaving it running in the background.

Usage: serverpod runner start [-- <server-args>]
-h, --help            Print this usage information.
-w, --[no-]watch      Watch files and use the Frontend Server.
                      (defaults to on)
-d, --directory       The server directory.
                      (defaults to "")
    --[no-]docker     Start Docker Compose services if a compose file exists.
    --[no-]flutter    Auto-launch companion Flutter apps on the first UI attach.
                      (defaults to on)

Run "serverpod help" to see global options.

attach​

Attach to the development stack already running for this project.

Usage: serverpod runner attach
-h, --help         Print this usage information.
-d, --directory    The server directory (defaults to auto-detect from current directory).
    --[no-]tui     Show the interactive terminal UI.
                   (defaults to on)

Run "serverpod help" to see global options.

status​

Print the development stack's state and addresses for this project.

Usage: serverpod runner status
-h, --help         Print this usage information.
-d, --directory    The server directory (defaults to auto-detect from current directory).

Run "serverpod help" to see global options.

stop​

Stop the development stack running for this project.

Usage: serverpod runner stop
-h, --help         Print this usage information.
-d, --directory    The server directory (defaults to auto-detect from current directory).

Run "serverpod help" to see global options.