Skip to main content

Subspace CLI (Recommended)

Recommended

Subspace CLI is the recommended way to farm on the Subspace Network. To get started, follow the guide below. For more information, you can check out the project README on GitHub.

Pre-Requisites​

System Requirements​

Farming can be Network Intensive.

Make sure you have a stable network connection. During the plotting phase of farming, it can be network intensive.

This may impact your network usage so please check your network connection if you have a hard data limit.

CoW File Systems Warning

It is advised not to use the Subspace farmer and node on CoW file systems for any OS.

If BTRFS is used with Subspace, the directory/whole file system must be CoW disabled with the following command prior to starting Subspace.

Command to Cow Disable

sudo chattr +C path/to/data

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

Subspace CLI requires commodity hardware specs to operate. At a minimum, you should have:

  • CPU with greater than 2 cores
  • 4 GB RAM (8 GB is recommended)
  • 150 GB Storage

Getting A Crypto Wallet​

Before running anything you need to have a wallet where you'll receive testnet coins. Follow our how-to guides in the Wallets section of the documentation for steps on how to get your wallet setup.

Installation​

ALPHA SOFTWARE

Subspace CLI is in alpha. Please feel free to file bug reports on our GitHub issues. Subspace CLI is still in alpha.

Download Binaries​

Compiled versions of the Subspace CLI is hosted on GitHub. This is the recommended way to install the application. Please find the appropriate binary for your operating system.

  1. Download the Release Binary below.
Windows CLI Executable
  1. Open Powershell, type cd Downloads (or cd Your-File-Location).

Configuration​

To start we will have to initialize our Farmer, this can be done with:

subspace-cli-windows-x86_64-v0.1.3-alpha.exe init

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

$ ./subspace-cli-ubuntu-x86_64-v0.1.3-alpha init

version: 0.1.0

SUBSPACE NETWORK

Configuration creation process has started...
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 plot location (press enter to use the default: `"/home/username/.local/share/subspace-cli/plots"`):
Specify a plot size (defaults to `100.0 GB`, press enter to use the default):
Specify the chain to farm(defaults to `dev`, press enter to use the default):
Configuration has been generated at /home/username/.config/subspace-cli
Ready for lift off! Run the follow command to begin:
`./subspace-cli farm`
Finding your settings.toml

After running subspace-cli init, the prompt will display where the settings.toml is generated. However in case you missed it, you can find the file based on your operating system:

Your settings.toml will be found in $FOLDERID_RoamingAppData/subspace-cli/settings.toml

Gemini 3 Testnet​

Use the default generated configuration!

The default configuration generated by Subspace CLI will have you ready for Gemini 3.

If you are using the default configurations from Subspace CLI, you are ready to go with the Gemini 3 Testnet. Alternatively, you can ensure this occurs by manually setting the network like so.

Open your settings.toml directory and ensure your chain is correctly specified to gemini-3a as so:

# settings.toml
[node]
chain = 'gemini-3a'
# ... redacted ...

Local Development​

To run Subspace CLI in a local development mode, modify your settings.toml and ensure your chain points to dev:

# settings.toml
[node]
chain = 'dev'
# ... redacted ...

Farming​

To begin farming on the network, just run the farm command with the CLI like so:

./subspace-cli-windows-x86_64-v0.1.3-alpha.exe farm

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

$ ./subspace-cli-ubuntu-x86_64-v0.1.3-alpha farm
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/subspace-cli/plots)
⠁ [00:00:00] 3% [=>                                      ]
      (31.00 MiB/953.67 MiB) 157.35 GiB/s, plotting, ETA: 0s

That's it! Enjoy and Happy Farming!

Moving the Farming Process to the Background​

  • Create a new tmux session using a socket file named farming
$ tmux -S farming
  • Move process to background by detaching
Ctrl+b d OR ⌘+b d (Mac)
  • To re-attach
$ tmux -S farming attach
  • To delete farming session
$ tmux kill-session -t farming