OS Manuals

/opt/chainguard/dagster/bin/dagster-graphql

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-graphql --help (exit 0). permalink

Usage: dagster-graphql [OPTIONS]

  Run a GraphQL query against the dagster interface to a specified repository
  or pipeline/job.

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

  Examples:

  1. dagster-graphql

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

  3. dagster-graphql -f path/to/file.py -a define_repo

  4. dagster-graphql -m some_module -a define_repo

  5. dagster-graphql -f path/to/file.py -a define_pipeline

  6. dagster-graphql -m some_module -a define_pipeline

Options:
  --version                       Show the version and exit.
  -t, --text TEXT                 GraphQL document to execute passed as a
                                  string
  --file FILENAME                 GraphQL document to execute passed as a file
  -p, --predefined [launchPipelineExecution]
                                  GraphQL document to execute, from a
                                  predefined set provided by dagster-graphql.
  -v, --variables TEXT            A JSON encoded string containing the
                                  variables for GraphQL execution.
  -r, --remote TEXT               A URL for a remote instance running dagster-
                                  webserver to send the GraphQL request to.
  -o, --output TEXT               A file path to store the GraphQL response
                                  to. This flag is useful when making
                                  pipeline/job execution queries, since
                                  pipeline/job execution causes logs to print
                                  to stdout and stderr.
  --ephemeral-instance            Use an ephemeral DagsterInstance instead of
                                  resolving via DAGSTER_HOME
  --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 (20)
OptionDescriptionSource
--grpc-port, --grpc-sockethelp
--versionShow the version and exit.help
-t, --text TEXTGraphQL document to execute passed as a stringhelp
--file FILENAMEGraphQL document to execute passed as a filehelp
-p, --predefined launchPipelineExecutionGraphQL document to execute, from a predefined set provided by dagster-graphql.help
-v, --variables TEXTA JSON encoded string containing the variables for GraphQL execution.help
-r, --remote TEXTA URL for a remote instance running dagster- webserver to send the GraphQL request to.help
-o, --output TEXTA file path to store the GraphQL response to.help
--ephemeral-instanceUse an ephemeral DagsterInstance instead of resolving via DAGSTER_HOMEhelp
--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.