OS Manuals

/usr/bin/pyspark

Jupyter all-spark-notebook image content combining the upstream jupyter/docker-stacks layer chain (base-notebook, minimal-notebook, scipy-notebook, pyspark-notebook, all-spark-notebook) into a single APK with the scientific Python stack, Apache Spark, R, and Spark/R kernels on top of jupyter-base-notebook.

From jupyter-all-spark-notebook 7.6.1_git20261106-r0 (enterprise-packages), captured 2026-11-08 by running pyspark --help (exit 0). permalink

Usage: ./bin/pyspark [options]

Options:
  --master MASTER_URL         spark://host:port, mesos://host:port, yarn,
                              k8s://https://host:port, or local (Default: local[*]).
  --deploy-mode DEPLOY_MODE   Whether to launch the driver program locally ("client") or
                              on one of the worker machines inside the cluster ("cluster")
                              (Default: client).
  --class CLASS_NAME          Your application's main class (for Java / Scala apps).
  --name NAME                 A name of your application.
  --jars JARS                 Comma-separated list of jars to include on the driver
                              and executor classpaths.
  --packages                  Comma-separated list of maven coordinates of jars to include
                              on the driver and executor classpaths. Will search the local
                              maven repo, then maven central and any additional remote
                              repositories given by --repositories. The format for the
                              coordinates should be groupId:artifactId:version.
  --exclude-packages          Comma-separated list of groupId:artifactId, to exclude while
                              resolving the dependencies provided in --packages to avoid
                              dependency conflicts.
  --repositories              Comma-separated list of additional remote repositories to
                              search for the maven coordinates given with --packages.
  --py-files PY_FILES         Comma-separated list of .zip, .egg, or .py files to place
                              on the PYTHONPATH for Python apps.
  --files FILES               Comma-separated list of files to be placed in the working
                              directory of each executor. File paths of these files
                              in executors can be accessed via SparkFiles.get(fileName).
  --archives ARCHIVES         Comma-separated list of archives to be extracted into the
                              working directory of each executor.

  --conf, -c PROP=VALUE       Arbitrary Spark configuration property.
  --properties-file FILE      Path to a file from which to load extra properties. If not
                              specified, this will look for conf/spark-defaults.conf.

  --driver-memory MEM         Memory for driver (e.g. 1000M, 2G) (Default: 1024M).
  --driver-java-options       Extra Java options to pass to the driver.
  --driver-library-path       Extra library path entries to pass to the driver.
  --driver-class-path         Extra class path entries to pass to the driver. Note that
                              jars added with --jars are automatically included in the
                              classpath.

  --executor-memory MEM       Memory per executor (e.g. 1000M, 2G) (Default: 1G).

  --proxy-user NAME           User to impersonate when submitting the application.
                              This argument does not work with --principal / --keytab.

  --help, -h                  Show this help message and exit.
  --verbose, -v               Print additional debug output.
  --version,                  Print the version of current Spark.

 Spark Connect only:
   --remote CONNECT_URL       URL to connect to the server for Spark Connect, e.g.,
                              sc://host:port. --master and --deploy-mode cannot be set
                              together with this option. This option is experimental, and
                              might change between minor releases.

 Cluster deploy mode only:
  --driver-cores NUM          Number of cores used by the driver, only in cluster mode
                              (Default: 1).

 Spark standalone or Mesos with cluster deploy mode only:
  --supervise                 If given, restarts the driver on failure.

 Spark standalone, Mesos or K8s with cluster deploy mode only:
  --kill SUBMISSION_ID        If given, kills the driver specified.
  --status SUBMISSION_ID      If given, requests the status of the driver specified.

 Spark standalone and Mesos only:
  --total-executor-cores NUM  Total cores for all executors.

 Spark standalone, YARN and Kubernetes only:
  --executor-cores NUM        Number of cores used by each executor. (Default: 1 in
                              YARN and K8S modes, or all available cores on the worker
                              in standalone mode).

 Spark on YARN and Kubernetes only:
  --num-executors NUM         Number of executors to launch (Default: 2).
                              If dynamic allocation is enabled, the initial number of
                              executors will be at least NUM.
  --principal PRINCIPAL       Principal to be used to login to KDC.
  --keytab KEYTAB             The full path to the file that contains the keytab for the
                              principal specified above.

 Spark on YARN only:
  --queue QUEUE_NAME          The YARN queue to submit to (Default: "default").
Options (33)
OptionDescriptionSource
--master MASTER_URLspark://host:port, mesos://host:port, yarn, k8s://https://host:port, or local (Default: local[*]).help
--deploy-mode DEPLOY_MODEWhether to launch the driver program locally ("client") or on one of the worker machines inside the cluster ("cluster") (Default: client).help
--class CLASS_NAMEYour application's main class (for Java / Scala apps).help
--name NAMEA name of your application.help
--jars JARSComma-separated list of jars to include on the driver and executor classpaths.help
--packagesComma-separated list of maven coordinates of jars to include on the driver and executor classpaths.help
--exclude-packagesComma-separated list of groupId:artifactId, to exclude while resolving the dependencies provided in --packages to avoid dependency conflicts.help
--repositoriesComma-separated list of additional remote repositories to search for the maven coordinates given with --packages.help
--py-files PY_FILESComma-separated list of .zip, .egg, or .py files to place on the PYTHONPATH for Python apps.help
--files FILESComma-separated list of files to be placed in the working directory of each executor.help
--archives ARCHIVESComma-separated list of archives to be extracted into the working directory of each executor.help
--conf, -c PROP=VALUEArbitrary Spark configuration property.help
--properties-file FILEPath to a file from which to load extra properties.help
--driver-memory MEMMemory for driver (e.g. 1000M, 2G) (Default: 1024M).help
--driver-java-optionsExtra Java options to pass to the driver.help
--driver-library-pathExtra library path entries to pass to the driver.help
--driver-class-pathExtra class path entries to pass to the driver.help
--executor-memory MEMMemory per executor (e.g. 1000M, 2G) (Default: 1G).help
--proxy-user NAMEUser to impersonate when submitting the application.help
--help, -hShow this help message and exit.help
--verbose, -vPrint additional debug output.help
--versionPrint the version of current Spark.help
--remote CONNECT_URLURL to connect to the server for Spark Connect, e.g., sc://host:port.help
--driver-cores NUMNumber of cores used by the driver, only in cluster mode (Default: 1).help
--superviseIf given, restarts the driver on failure.help
--kill SUBMISSION_IDIf given, kills the driver specified.help
--status SUBMISSION_IDIf given, requests the status of the driver specified.help
--total-executor-cores NUMTotal cores for all executors.help
--executor-cores NUMNumber of cores used by each executor.help
--num-executors NUMNumber of executors to launch (Default: 2).help
--principal PRINCIPALPrincipal to be used to login to KDC.help
--keytab KEYTABThe full path to the file that contains the keytab for the principal specified above.help
--queue QUEUE_NAMEThe YARN queue to submit to (Default: "default").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.