CLI Reference
Complete reference for the nonos command-line interface.
Global Options
nonos [OPTIONS] <COMMAND>--config <PATH>
-c
Custom config file path
--data-dir <PATH>
-d
Custom data directory
--log-level <LEVEL>
-l
Log level: trace, debug, info, warn, error
--quiet
-q
Suppress non-essential output
--json
-j
Output in JSON format
--version
-V
Print version information
--help
-h
Print help information
Commands
Node Operations
nonos init
Initialize a new node configuration.
nonos init [OPTIONS]--reward-address <ADDR>
Ethereum address for rewards (required)
--name <NAME>
Human-readable node name
--force
Overwrite existing configuration
Example:
nonos run
Start the daemon.
--systemd
Enable systemd integration (notify, watchdog)
--foreground
Run in foreground (default)
--pidfile <PATH>
Write PID to file
Example:
nonos stop
Stop a running daemon.
--graceful
Wait for pending operations (default)
--force
Immediate shutdown
--timeout <SECS>
Graceful shutdown timeout
nonos status
Check daemon status.
--watch
Continuous status updates
--interval <SECS>
Update interval for --watch
Output:
nonos info
Display detailed node information.
--full
Include all details
--network
Network information only
--identity
Identity information only
Staking Commands
nonos stake status
Show current staking status.
Output:
nonos stake deposit
Deposit NOX tokens to stake.
--max
Deposit entire wallet balance
--gas-price <GWEI>
Custom gas price
--dry-run
Simulate without executing
Example:
nonos stake withdraw
Withdraw staked NOX tokens.
--all
Withdraw entire stake
--force
Skip confirmation
Example:
nonos stake tiers
Display staking tier information.
Output:
nonos stake tier
Change staking tier.
Tiers: bronze, silver, gold, platinum, diamond
Example:
Rewards Commands
nonos rewards status
Show pending rewards.
--epoch
Show current epoch details
Output:
nonos rewards claim
Claim pending rewards.
--gas-price <GWEI>
Custom gas price
--dry-run
Simulate without executing
nonos rewards history
Show reward history.
--limit <N>
Number of entries (default: 10)
--epoch <N>
Show specific epoch
--csv
Output as CSV
nonos rewards auto
Configure auto-claiming.
--enable
Enable auto-claim
--disable
Disable auto-claim
--threshold <NOX>
Minimum to trigger claim
Example:
Network Commands
nonos peers list
List connected peers.
--limit <N>
Number of peers to show
--sort <FIELD>
Sort by: latency, uptime, quality
Output:
nonos peers connect
Manually connect to a peer.
Example:
nonos peers disconnect
Disconnect from a peer.
Identity Commands
nonos identity generate
Generate a new ZK identity.
--name <NAME>
Human-readable label
nonos identity list
List all identities.
Output:
nonos identity prove
Generate a membership proof.
--nullifier <HEX>
Specific nullifier to use
--output <FILE>
Write proof to file
nonos identity revoke
Revoke an identity.
--force
Skip confirmation
Diagnostic Commands
nonos check
Run diagnostic checks.
Components: all, network, storage, hardware, config
Example:
Output:
nonos stats
Show network statistics.
--live
Real-time updates
--interval <SECS>
Update interval
nonos logs
View daemon logs.
--follow
Stream new logs
--lines <N>
Number of lines
--level <LEVEL>
Filter by level
--component <NAME>
Filter by component
Dashboard
nonos dash
Launch the TUI dashboard.
--refresh <MS>
Refresh rate (default: 1000)
Features:
Real-time metrics visualization
Peer map
Reward tracking
Log viewer
Quality score graphs
Configuration Commands
nonos config show
Display current configuration.
Sections: all, node, network, staking, rewards, services
nonos config set
Set a configuration value.
Example:
nonos config reset
Reset configuration to defaults.
--keep-identity
Preserve node identity
System Integration
nonos systemd
Generate systemd service file.
--output-dir <PATH>
Output directory
--user <USER>
Service user
--install
Install and enable service
Environment Variables
NONOS_WALLET_KEY
Ethereum private key
Required
NONOS_DATA_DIR
Data directory
~/.nonos
NONOS_CONFIG
Config file path
~/.nonos/config.toml
NONOS_API_PORT
API port
8420
NONOS_P2P_PORT
P2P port
9000
NONOS_LOG_LEVEL
Log level
info
NONOS_RPC_URL
Ethereum RPC URL
Public node
Exit Codes
0
Success
1
General error
2
Configuration error
3
Network error
4
Blockchain error
5
Insufficient stake
126
Permission denied
127
Command not found
See also: Configuration Guide for detailed configuration options
Last updated
Was this helpful?