Skip to content

hazyone/subspace-cli

 
 

Repository files navigation

Subspace CLI

Subspace CLI simplifies the farming process on Subspace Network.

ci-tests Rust Docs Latest Release

prompt


Instead of running a terminal instance for the farmer, and running another terminal instance for the node, now you can run a SINGLE terminal instance to farm!

How to Use (commands)

  1. download the executable from releases
  2. in your terminal, change your directory to where you download the file for example: if you downloaded your file to your Downloads folder, cd Downloads)
  3. we will address your executable name as subspace-cli, change the below commands accordingly to your full executable name.
  4. run ./subspace-cli init -> this will initialize your config file, which will store the necessary information for you to farm.
  5. run ./subspace-cli farm -> this will start farming. Yes, it is that simple! Enjoy!

Other commands

  • wipe -> This is a dangerous one. If you want to delete everything and start over, this will permanently delete your plots and your node data (this will not erase any rewards you have gained, don't worry).
  • info -> This will show info for your farming.

Daemonizing the Process (Moving it to the Background)

In some instances, you may want to move the farming process to the background. Tools like screen and tmux can help manage this.

Alt text

Example with tmux

$ tmux -S farming

This will create a new tmux session using a socket file named farming.

Once the tmux session is created, you can go ahead and run the farming process.

$ ./subspace-cli farm

Once it's running, you can detach the process by pressing CTRL+b d (read more about detaching a sessions)

That's it, you should be back to your terminal, with subspace farming running in the background as a session.

To re-attach to your session, use tmux:

$ tmux -S farming attach

If you ever want to delete/kill your farming session, enter the command:

tmux kill-session -t farming

Example with screen

screen -S farming

This will create a new screen session.

./subspace-cli farm

Once it's running, you can detach the process by pressing CTRL+d a.

To re-attach it to your current session:

screen -r farming

If you ever want to delete/kill your farming session, enter the command:

screen -S farming -X quit

About

The Subspace Network CLI for Nodes and Farmers

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 100.0%