Skip to content

Pearl CLI Integration

Locus includes a thin locus pearl wrapper for Pearl's native command line tools. It does not replace Pearl's node or wallet; it makes the common commands discoverable from the same CLI users use for mining.

Binary Discovery

locus pearl looks for pearld, oyster, and prlctl on PATH, then under $PEARL_HOME/bin.

export PEARL_HOME=/path/to/pearl
locus pearl doctor

Native Pass-Through

Use pass-through commands when you need the full Pearl surface:

locus pearl node -- --help
locus pearl wallet -- --help
locus pearl ctl -- --help

These map directly to:

Locus command Pearl binary
locus pearl node pearld
locus pearl wallet oyster
locus pearl ctl prlctl

The command format is always locus pearl <command>. Pearl-native arguments go after that command. Use -- before Pearl arguments when the arguments begin with dashes and you want to make the pass-through boundary explicit.

Wallet Address Helper

If Oyster is already running, generate a mining address through wallet RPC:

locus pearl address \
  -u rpcuser \
  -P rpcpass \
  -s localhost:44207

The helper uses prlctl --wallet and defaults to --notls, which matches the local validation flow. Use --tls --skipverify if your Oyster RPC endpoint is serving TLS with a local certificate.

Boundary

locus mine is the Locus mining lifecycle. locus pearl is an escape hatch to Pearl's native node, wallet, and RPC tools. For advanced node or wallet administration, Pearl's own help output is the source of truth.