OS Manuals

/opt/chainguard/dagster/bin/dagster-webserver

Dagster data orchestration platform for building and maintaining data assets

From dagster 1.13.29-r0 (enterprise-packages), captured 2026-11-08 by running dagster-webserver --help (exit 0). permalink

Usage: dagster-webserver [OPTIONS]

  Run dagster-webserver. Loads a code location.

  Can only use ONE of --workspace/-w, --python-file/-f, --module-name/-m,
  --grpc-port, --grpc-socket.

  Examples:

  1. dagster-webserver (works if ./workspace.yaml exists)

  2. dagster-webserver -w path/to/workspace.yaml

  3. dagster-webserver -f path/to/file.py

  4. dagster-webserver -f path/to/file.py -d path/to/working_directory

  5. dagster-webserver -m some_module

  6. dagster-webserver -f path/to/file.py -a define_repo

  7. dagster-webserver -m some_module -a define_repo

  8. dagster-webserver -p 3333

  Options can also provide arguments via environment variables prefixed with
  DAGSTER_WEBSERVER.

  For example, DAGSTER_WEBSERVER_PORT=3333 dagster-webserver

Options:
  -h, --host TEXT                 Host to run server on  [default: 127.0.0.1]
  -p, --port INTEGER              Port to run server on - defaults to 3000
  -l, --path-prefix TEXT          The path prefix where server will be hosted
                                  (eg: /dagster-webserver)  [default: ""]
  --db-statement-timeout INTEGER  The timeout in milliseconds to set on
                                  database statements sent to the
                                  DagsterInstance. Not respected in all
                                  configurations.  [default: 15000]
  --db-pool-recycle INTEGER       The maximum age of a connection to use from
                                  the sqlalchemy pool without connection
                                  recycling. Set to -1 to disable. Not
                                  respected in all configurations.  [default:
                                  3600]
  --db-pool-max-overflow INTEGER  The maximum overflow size of the sqlalchemy
                                  pool. Set to -1 to disable.Not respected in
                                  all configurations.  [default: 20]
  --read-only                     Start server in read-only mode, where all
                                  mutations such as launching runs and turning
                                  schedules on/off are turned off.
  --suppress-warnings             Filter all warnings when hosting server.
  --uvicorn-log-level, --log-level [critical|error|warning|info|debug|trace]
                                  Set the log level for the uvicorn web
                                  server.  [default: warning]
  --dagster-log-level [critical|error|warning|info|debug]
                                  Set the log level for dagster log events.
                                  [default: info]
  --log-format [colored|json|rich]
                                  Format of the log output from the webserver
                                  [default: colored]
  --code-server-log-level [critical|error|warning|info|debug]
                                  Set the log level for any code servers spun
                                  up by the webserver.  [default: info]
  --live-data-poll-rate INTEGER   Rate at which the dagster UI polls for
                                  updated asset data (in milliseconds)
                                  [default: 2000]
  --version                       Show the version and exit.
  --use-ssl                       Use a secure channel when connecting to the
                                  gRPC server
  --grpc-host TEXT                Host to use to connect to gRPC server,
                                  defaults to localhost
  --grpc-socket PATH              Named socket to use to connect to gRPC
                                  server
  --grpc-port INTEGER             Port to use to connect to gRPC server
  -a, --attribute TEXT            Attribute that is either a 1) repository or
                                  job or 2) a function that returns a
                                  repository or job
  --package-name TEXT             Specify Python package where repository or
                                  job function lives
  --autoload-defs-module-name TEXT
                                  A module to import and recursively search
                                  through for definitions.
  -m, --module-name TEXT          Specify module or modules (flag can be used
                                  multiple times) where dagster definitions
                                  reside as top-level symbols/variables and
                                  load each module as a code location in the
                                  current python environment.
  -f, --python-file PATH          Specify python file or files (flag can be
                                  used multiple times) where dagster
                                  definitions reside as top-level
                                  symbols/variables and load each file as a
                                  code location in the current python
                                  environment.
  -d, --working-directory TEXT    Specify working directory to use when
                                  loading the repository or job
  -w, --workspace PATH            Path to workspace file. Argument can be
                                  provided multiple times.
  --empty-workspace               Allow an empty workspace
  --help                          Show this message and exit.
Options (26)
OptionDescriptionSource
--grpc-port, --grpc-sockethelp
-h, --host TEXTHost to run server on [default: 127.0.0.1]help
-p, --port INTEGERPort to run server on - defaults to 3000help
-l, --path-prefix TEXTThe path prefix where server will be hosted (eg: /dagster-webserver) [default: ""]help
--db-statement-timeout INTEGERThe timeout in milliseconds to set on database statements sent to the DagsterInstance.help
--db-pool-recycle INTEGERThe maximum age of a connection to use from the sqlalchemy pool without connection recycling.help
--db-pool-max-overflow INTEGERThe maximum overflow size of the sqlalchemy pool.help
--read-onlyStart server in read-only mode, where all mutations such as launching runs and turning schedules on/off are turned off.help
--suppress-warningsFilter all warnings when hosting server.help
--uvicorn-log-level, --log-level critical|error|warning|info|debug|traceSet the log level for the uvicorn web server.help
--dagster-log-level critical|error|warning|info|debugSet the log level for dagster log events.help
--log-format colored|json|richFormat of the log output from the webserver [default: colored]help
--code-server-log-level critical|error|warning|info|debugSet the log level for any code servers spun up by the webserver.help
--live-data-poll-rate INTEGERRate at which the dagster UI polls for updated asset data (in milliseconds) [default: 2000]help
--versionShow the version and exit.help
--use-sslUse a secure channel when connecting to the gRPC serverhelp
--grpc-host TEXTHost to use to connect to gRPC server, defaults to localhosthelp
-a, --attribute TEXTAttribute that is either a 1) repository or job or 2) a function that returns a repository or jobhelp
--package-name TEXTSpecify Python package where repository or job function liveshelp
--autoload-defs-module-name TEXTA module to import and recursively search through for definitions.help
-m, --module-name TEXTSpecify module or modules (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each module as a code location in the current python environment.help
-f, --python-file PATHSpecify python file or files (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each file as a code location in the current python environment.help
-d, --working-directory TEXTSpecify working directory to use when loading the repository or jobhelp
-w, --workspace PATHPath to workspace file.help
--empty-workspaceAllow an empty workspacehelp
--helpShow this message and exit.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.