Skip to content

CLI Reference

Complete command-line reference for neuroshard.

Basic Usage

bash
neuroshard [OPTIONS]

Options

Required

OptionDescription
--token <TOKEN>Your wallet token (64-char hex or 12-word mnemonic)

Core Options

OptionDefaultDescription
--port <PORT>8000HTTP port for the node
--tracker <URL>https://neuroshard.com/api/trackerTracker URL for peer discovery
--version-Show version and exit
--help-Show help message and exit

Network Options

OptionDefaultDescription
--announce-ip <IP>None (auto-detect)Force this IP address for peer announcements
--announce-port <PORT>None (uses --port)Force this port for peer announcements

Resource Limits

OptionDefaultDescription
--memory <MB>None (auto-detect ~70% of RAM)Max memory in MB
--cpu-threads <N>None (all cores)Max CPU threads to use
--max-storage <MB>100Max disk space for training data in MB

Training Options

OptionDefaultDescription
--no-trainingfalseDisable training (inference only)
--diloco-steps <N>500DiLoCo inner steps before gradient sync

UI Options

OptionDefaultDescription
--no-browserfalseDon't auto-open dashboard in browser
--headlessfalseRun without any UI (server mode)

Examples

Basic Startup

bash
neuroshard --token YOUR_WALLET_TOKEN

Custom Port

bash
neuroshard --token YOUR_TOKEN --port 9000

Limited Resources

bash
neuroshard --token YOUR_TOKEN \
  --memory 4096 \
  --cpu-threads 4 \
  --max-storage 50

Server Mode

bash
neuroshard --token YOUR_TOKEN \
  --headless \
  --no-browser

Inference Only

bash
neuroshard --token YOUR_TOKEN --no-training

Behind NAT/Firewall

bash
neuroshard --token YOUR_TOKEN \
  --announce-ip 203.0.113.50 \
  --announce-port 8001

Custom Tracker

bash
neuroshard --token YOUR_TOKEN \
  --tracker http://localhost:3000

Fast DiLoCo Sync

bash
neuroshard --token YOUR_TOKEN \
  --diloco-steps 100

Getting Your Token

The --token argument is required. You can get your wallet token at:

The token can be provided as:

  • A 64-character hexadecimal string
  • A 12-word BIP39 mnemonic phrase

Token Formats

Hexadecimal (64 characters)

bash
neuroshard --token a1b2c3d4e5f6...

Mnemonic (12 words)

bash
neuroshard --token "word1 word2 word3 word4 word5 word6 word7 word8 word9 word10 word11 word12"

The mnemonic is converted to a seed using BIP39.

Exit Codes

CodeMeaning
0Clean shutdown
1Invalid arguments or missing token

Signals

SignalAction
SIGINT (Ctrl+C)Graceful shutdown
SIGTERMGraceful shutdown

Output

Console Output

╔══════════════════════════════════════════════════════════════╗
║                                                              ║
║   ███╗   ██╗███████╗██╗   ██╗██████╗  ██████╗               ║
║   ████╗  ██║██╔════╝██║   ██║██╔══██╗██╔═══██╗              ║
║   ██╔██╗ ██║█████╗  ██║   ██║██████╔╝██║   ██║              ║
║   ██║╚██╗██║██╔══╝  ██║   ██║██╔══██╗██║   ██║              ║
║   ██║ ╚████║███████╗╚██████╔╝██║  ██║╚██████╔╝              ║
║   ╚═╝  ╚═══╝╚══════╝ ╚═════╝ ╚═╝  ╚═╝ ╚═════╝              ║
║                                                              ║
║            Decentralized AI Training Network                 ║
║                     v0.0.6                                   ║
╚══════════════════════════════════════════════════════════════╝

  🖥️  Device: CUDA (NVIDIA GeForce RTX 3080)

[NODE] ✅ Wallet recovered from mnemonic
[NODE] Starting on port 8000...
[NODE] Dashboard: http://localhost:8000/
[NODE] Assigned 24 layers: [0, 1, 2, ...]
[GENESIS] Data loader ready: 1024 shards available

Error Messages

If you don't provide a token, you'll see:

[ERROR] Wallet token required!

Get your token at: https://neuroshard.com/wallet
Or generate a new wallet with: neuroshard --help

Usage: neuroshard --token YOUR_TOKEN

The node will exit with code 1 if the token is missing or invalid.

See Also

Released under the MIT License.