Setup and building
Prerequisites​
| Dependency | Description |
|---|---|
| Git | The source code of Pulsar is hosted on GitHub as a git repository. To work with the git repository, please install git. We highly recommend that you also set up a Git mergetool for resolving merge conflicts. |
| JDK | The source code of Pulsar is primarily written in Java. Therefore, you need a working Java Development Kit (JDK) to build it. Pulsar requires JDK 17 to build. |
| Maven | The source code of Pulsar is managed by Apache Maven The required Maven version is 3.6.1+. |
| Zip | The build process requires Zip as a utility tool. |
note
On Windows, replace ./mvnw with mvnw.cmd in the commands below.
note
Pulsar does not support running server on Windows yet, you have to use Docker to run Pulsar. Please consider checking Run Pulsar In Docker
Clone​
Clone the source code to your development machine:
git clone https://github.com/apache/pulsar
The following commands are assumed to be executed from the project root directory:
cd pulsar
Build​
Compile and install to local Maven repository:
./mvnw clean install -DskipTests
Run​
bin/pulsar standalone
Connect​
bin/pulsar-shell