Install

Get Started with Pulsar

Pulsar (formerly Subspace CLI) is our recommended tool for farming on the Subspace Network. This ALPHA SOFTWARE is constantly evolving, and your feedback is invaluable in this process. To share your insights, please fill out this feedback form. For detailed guidance, follow the guide below and check out the README on GitHub. Should you encounter any issues, feel free to file bug reports on our GitHub.

Prefer a video? Click here for an installation tutorial.

警告

Please note that some older processors/VMs are no longer supported by official releases, but can still be compiled manually if needed. Precompiled versions of Pulsar are hosted on GitHub. Find the appropriate binary for your operating system below.

Get Started with Pulsar Installation

🖼️ Windows

Windows Specific Warnings:

Windows No Output Bug

If you face an error where the node outputs nothing and no error code is given it is likely you just need to install the latest Visual C++ Redistributable package here

Step 1: Download the Pulsar Executable

---

Pulsar Executable(Legacy CPU)Pulsar Executable(Skylake+ CPU)

Step 2: Initialize Pulsar

---

We will now initialize Pulsar. This is where we will configure Reward Address, Plot Size, Plot Location, etc.

1. Open Powershell, type cd Downloads (or cd Your-File-Location).
2. Execute the init command as seen below.

./pulsar-windows-x86_64-skylake-v0.7.2-alpha.exe init

3. This will prompt you to setup your Pulsar configurations to begin farming. You should see a similar prompt like so:

Configuration creation process has started...
Do you have an existing farmer/reward address? [y/n]: y
Enter your farmer/reward address: REDACTED_ADDRESS
Enter your node name to be identified on the network (defaults to `username`, press enter to use the default):
Specify a path for storing plot files (press enter to use the default: `"/home/username/.local/share/pulsar/farms"`):
Specify a path for storing node files (press enter to use the default: `"/home/username/.local/share/pulsar/node"`):
Specify a plot size (defaults to `2.0 GB`, press enter to use the default):
Specify the chain to farm. Available options are: [Gemini3g, Dev, DevNet].
Defaults to `Gemini3g`, press enter to use the default:
Configuration has been generated at /home/username/.config/pulsar
Ready for lift off! Run the follow command to begin: `"path/to/executable" farm`

4. Once complete, the settings will be written to the settings.toml. You can find Your settings.toml in $FOLDERID_RoamingAppData/pulsar/settings.toml

Step 3. Start Farming with Pulsar

---

危险

A Windows Defender Firewall has blocked some features of this app warning may appear. This is because the application is trying to access the internet. This is expected as it is how the farmer talks to other farmers on the network, select Allow access to continue farming.

We will now start the farmer with the farm command

1. Run the following command below to start farming with Pulsar.

./pulsar-windows-x86_64-skylake-v0.7.2-alpha.exe farm

2. You should see the farmer and node start successfully and begin syncing, plotting, and then farming:

Starting node ... (this might take up to couple of minutes)
Node started successfully!
Starting farmer ...
Farmer started successfully!
Initial plotting for plot: #0 (/home/username/.local/share/pulsar/farms)
⠁ [00:00:00] 3% [=>                                      ]
      (31.00 MiB/953.67 MiB) 157.35 GiB/s, plotting, ETA: 0s

3. That's it! Enjoy and Happy Farming!

🍎macOS

macOS Specific Warnings:

警告

Your Mac may not let you open/initialize the file because of unidentified developer restrictions. To resolve this, go to Settings-> Security&Privacy -> General -> Allow

Step 1: Download the Pulsar Binaries

---

Pulsar Binary(Intel CPU)Pulsar Binary(Apple CPU)

Step 2: Initialize Pulsar

---

备注

Your Mac may not let you open/initialize the file because of unidentified developer restrictions. To resolve this, go to Settings-> Security&Privacy -> General -> Allow

We will now initialize Pulsar. This is where we will configure Reward Address, Plot Size, Plot Location, etc.

1. Open Terminal, type cd Downloads (or cd Your-File-Location).
2. Make the binary executable by running:
   • chmod +x [pulsary-binary-filename-here]
3. Execute the init command as seen below.

./pulsar-macos-x86_64-v0.7.2-alpha  init

4. This will prompt you to setup your Pulsar configurations to begin farming. You should see a similar prompt like so:

Configuration creation process has started...
Do you have an existing farmer/reward address? [y/n]: y
Enter your farmer/reward address: REDACTED_ADDRESS
Enter your node name to be identified on the network (defaults to `username`, press enter to use the default):
Specify a path for storing plot files (press enter to use the default: `"/home/username/.local/share/pulsar/farms"`):
Specify a path for storing node files (press enter to use the default: `"/home/username/.local/share/pulsar/node"`):
Specify a plot size (defaults to `2.0 GB`, press enter to use the default):
Specify the chain to farm. Available options are: [Gemini3g, Dev, DevNet].
Defaults to `Gemini3g`, press enter to use the default:
Configuration has been generated at /home/username/.config/pulsar
Ready for lift off! Run the follow command to begin: `"path/to/executable" farm`

5. Once complete, the settings will be written to the settings.toml. You can find Your settings.toml in $HOME/Library/Application Support/pulsar/settings.toml

Step 3. Start Farming with Pulsar

---

We will now start the farmer with the farm command

1. Run the following command below to start farming with Pulsar.

./pulsar-macos-x86_64-v0.7.2-alpha farm

2. You should see the farmer and node start successfully and begin syncing, plotting, and then farming:

Starting node ... (this might take up to couple of minutes)
Node started successfully!
Starting farmer ...
Farmer started successfully!
Initial plotting for plot: #0 (/home/username/.local/share/pulsar/farms)
⠁ [00:00:00] 3% [=>                                      ]
      (31.00 MiB/953.67 MiB) 157.35 GiB/s, plotting, ETA: 0s

3. That's it! Enjoy and Happy Farming!

🐧Ubuntu

Linux Specific Warnings:

CoW Filesystems Warning

It is advised not to use the Subspace farmer and node on CoW file systems for any OS (ReFS, BTRFS, ZFS, bcachefs, HAMMER and some more).

If BTRFS is used with Subspace, the directory/whole file system must be CoW disabled with the following command prior to starting Subspace, because it only applies to newly created files.

Command to Disable CoW on BTRFS

sudo chattr +C path/to/data/dir

Alternatively, non-CoW file systems like ext4 or XFS can be used instead.

Redundancy

Using redundancy (RAID1/5/6, RAIDZ and others) on a filesystem with plot makes no sense, as the farmer uses checksums to verify the integrity of the plot, and is able to recover corrupted blocks if necessary in most cases. See scrub command below.

Filesystem chunk size

Creating a filesystem with a chunk (sunit) size of 32KB can prevent data fragmentation and improve performance, since the farmer operates on ~32KB chunks.

XFS

sudo mkfs.xfs -d su=32k,sw=1 /path/to/dev

Then use largeio and swalloc mount options.

ext4

sudo mkfs.ext4 -E stride=8,stripe-width=8 /path/to/dev

You can change these settings for an existing file system:

sudo tune2fs -E stride=8,stripe-width=8 /path/to/dev

Step 1: Download the Pulsar Binaries

---

Pulsar Binary(Legacy CPU)Pulsar Binary(Skylake+ CPU)Pulsar Binary(Aarch64/Raspberry Pi)

Step 2: Initialize Pulsar

---

We will now initialize Pulsar. This is where we will configure Reward Address, Plot Size, Plot Location, etc.

1. Open Terminal, type cd Downloads (or cd Your-File-Location).
2. Make the binary executable by running:
   • chmod +x [pulsary-binary-filename-here]
3. Execute the init command as seen below.

./pulsar-ubuntu-x86_64-skylake-v0.7.2-alpha  init

4. This will prompt you to setup your Pulsar configurations to begin farming. You should see a similar prompt like so:

Configuration creation process has started...
Do you have an existing farmer/reward address? [y/n]: y
Enter your farmer/reward address: REDACTED_ADDRESS
Enter your node name to be identified on the network (defaults to `username`, press enter to use the default):
Specify a path for storing plot files (press enter to use the default: `"/home/username/.local/share/pulsar/farms"`):
Specify a path for storing node files (press enter to use the default: `"/home/username/.local/share/pulsar/node"`):
Specify a plot size (defaults to `2.0 GB`, press enter to use the default):
Specify the chain to farm. Available options are: [Gemini3g, Dev, DevNet].
Defaults to `Gemini3g`, press enter to use the default:
Configuration has been generated at /home/username/.config/pulsar
Ready for lift off! Run the follow command to begin: `"path/to/executable" farm`

5. Once complete, the settings will be written to the settings.toml. You can find Your settings.toml in $HOME/.config/pulsar/settings.toml

Step 3. Start Farming with Pulsar

---

We will now start the farmer with the farm command

1. Run the following command below to start farming with Pulsar.

./pulsar-ubuntu-x86_64-skylake-v0.7.2-alpha farm

2. You should see the farmer and node start successfully and begin syncing, plotting, and then farming:

Starting node ... (this might take up to couple of minutes)
Node started successfully!
Starting farmer ...
Farmer started successfully!
Initial plotting for plot: #0 (/home/username/.local/share/pulsar/farms)
⠁ [00:00:00] 3% [=>                                      ]
      (31.00 MiB/953.67 MiB) 157.35 GiB/s, plotting, ETA: 0s

3. That's it! Enjoy and Happy Farming!