CLI Terminal Commands

This page should provide additional high-level documentation and explanation beyond just rolls -h.

Usually, the -h (help) text is clear enough. If you do need more context, use the -h switch in the terminal.

Example of Rolls-blockchain terminal commands:

• rolls -h
• rolls plots -h
• rolls plots check -h
• rolls start -h

As with the rest of this project, this doc is a work-in-progress. Feel free to browse the source code to find out more.

Locate the rolls binary executable

Mac

If you installed PecanRolls.app in your /Applications directory, you can find the rolls binary at /Applications/PecanRolls.app/Contents/Resources/app.asar.unpacked/daemon/rolls.

Do a sanity check in Terminal.app with

/Applications/PecanRolls.app/Contents/Resources/app.asar.unpacked/daemon/rolls -h

You can use that if you augment your PATH with

PATH=/Applications/PecanRolls.app/Contents/Resources/app.asar.unpacked/daemon:$PATH

and then rolls -h should work.

Windows

There is more than one PecanRolls.exe binary; the GUI is PecanRolls.exe (two of these!) and the CLI is rolls.exe. They are found in different places. Note the big C versus the little c.

~\AppData\Local\rolls-blockchain\app-1.1.3\resources\app.asar.unpacked\daemon\rolls.exe

init

Command: rolls init

First, init checks for old versions of rolls installed in your ~/.rolls directory.

If so, init migrates these old files to the new version:

config (including old SSL files) db wallet Using config.yaml, updates wallet keys and ensures coinbase rewards go to the right wallet puzzlehash. If no old version exists, init:

Creates a default rolls configuration Initializes a new SSL key and cert (for secure communication with the GUI)

start

Command: rolls start {service}

Service node will start only the full node. Service farmer will start the farmer, harvester, a full node, and the wallet. positional arguments: {all,node,harvester,farmer,farmer-no-wallet,farmer-only,timelord,timelord-only,timelord-launcher-only,wallet,wallet-only,introducer,simulator} Flags

-r, --restart: Restart of running processes

Other commands (not yet documented)

$ rolls

Options:
  --root-path PATH  Config file root  [default: /home/mariano/.rolls/mainnet]
  -h, --help        Show this message and exit.

Commands:
  configure   Modify configuration
  farm        Manage your farm
  init        Create or migrate the configuration
  keys        Manage your keys
  netspace    Estimate total farmed space on the network
  plots       Manage your plots
  run_daemon  Runs rolls daemon
  show        Show node information
  start       Start service groups
  stop        Stop services
  version     Show rolls version
  wallet      Manage your wallet

To see what you can do with each of these commands, use the help flag -h. For example, rolls show -h.

To check your full node status, do rolls show -s and you'll see something like this. To figure how close you are look at your height. Once fully synced it'll say Full Node Synced at the top.

Current Blockchain Status: Full Node Synced

Peak: Hash: 34554a10aff6b52545623e18667c9487758fa93a3b2345974da0d263939189dc
      Time: Tue Mar 23 2021 20:54:46 JST                  Height:      19882

Estimated network space: 136.225 PiB
Current difficulty: 9
Current VDF sub_slot_iters: 112197632
Total iterations since the start of the blockchain: 63291534050

  Height: |   Hash:
    19882 | 34554a10aff6b52545623e18667c9487758fa93a3b2345974da0d263939189dc
    19881 | f53c052cd7ac58539ff5c35cb9d515bc521308a49cec7566b23dba84f76009d8
    19880 | 924d825a7fdbfd61e4582efbbe1d977bb554b368eea58c349a71e688e43fcc49

You can add and remove directories for your plots with rolls plots add -d 'your_dir' or rolls plots remove -d 'your_dir'

Checking Logs and Status

You can check contents of your wallet with: rolls wallet, and status of your farmer with rolls farm summary.

Check harvester and farmer logs: grep ~/.rolls/mainnet/log/debug.log -e harvester

Do a running log on Linux: tail -f ~/.rolls/mainnet/log/debug.log