OS Manuals

/usr/share/java/pulsar/bin/pulsar

Pulsar is a distributed pub-sub messaging platform with a very flexible messaging model and an intuitive client API.

From apache-pulsar-4.2 4.2.2-r0 (os), captured 2026-11-05 by running pulsar --help (exit 0). permalink

Usage: pulsar <command>
where command is one of:

    broker              Run a broker server
    bookie              Run a bookie server
    zookeeper           Run a zookeeper server
    configuration-store Run a configuration-store server
    proxy               Run a pulsar proxy
    websocket           Run a web socket proxy server
    functions-worker    Run a functions worker server
    standalone          Run a broker server with local bookies and local zookeeper
    autorecovery        Run an autorecovery service

    initialize-cluster-metadata     One-time metadata initialization
    delete-cluster-metadata         Delete a cluster's metadata
    initialize-transaction-coordinator-metadata     One-time transaction coordinator metadata initialization
    initialize-namespace     namespace initialization
    compact-topic       Run compaction against a topic
    zookeeper-shell     Open a ZK shell client
    broker-tool         CLI to operate a specific broker
    tokens              Utility to create authentication tokens
    version             Get the current version of pulsar

    help                This help message

or command is the full name of a class with a defined main() method.

Environment variables:
   FUNCTIONS_LOG_CONF            Function Log4j configuration file (default /usr/share/java/pulsar/conf/functions_log4j2.xml)
   PULSAR_LOG_CONF               Log4j configuration file (default /usr/share/java/pulsar/conf/log4j2.yaml)
   PULSAR_BROKER_CONF            Configuration file for broker (default: /usr/share/java/pulsar/conf/broker.conf)
   PULSAR_BOOKKEEPER_CONF        Configuration file for bookie (default: /usr/share/java/pulsar/conf/bookkeeper.conf)
   PULSAR_ZK_CONF                Configuration file for zookeeper (default: /usr/share/java/pulsar/conf/zookeeper.conf)
   PULSAR_CONFIGURATION_STORE_CONF         Configuration file for global configuration store (default: /usr/share/java/pulsar/conf/global_zookeeper.conf)
   PULSAR_WEBSOCKET_CONF         Configuration file for websocket proxy (default: /usr/share/java/pulsar/conf/websocket.conf)
   PULSAR_PROXY_CONF             Configuration file for Pulsar proxy (default: /usr/share/java/pulsar/conf/proxy.conf)
   PULSAR_WORKER_CONF            Configuration file for functions worker (default: /usr/share/java/pulsar/conf/functions_worker.yml)
   PULSAR_STANDALONE_CONF        Configuration file for standalone (default: /usr/share/java/pulsar/conf/standalone.conf)
   PULSAR_EXTRA_OPTS             Extra options to be passed to the jvm
   PULSAR_EXTRA_CLASSPATH        Add extra paths to the pulsar classpath
   PULSAR_PID_DIR                Folder where the pulsar server PID file should be stored
   PULSAR_STOP_TIMEOUT           Wait time before forcefully kill the pulsar server instance, if the stop is not successful
   PULSAR_LOG_LEVEL              Log level for the command run (default: info)
   PULSAR_LOG_ROOT_LEVEL         Log root level for the command run (default: $PULSAR_LOG_LEVEL)

These variable can also be set in conf/pulsar_env.sh

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