CLI Reference

Complete command reference for the QuikDB Nodes CLI tool.

Installation

# Install from NPM
npm install -g quikdb-nodes

# Verify installation
quikdb-nodes --version

Global Options

Available for all commands:

Option	Description
`--version`	Show version number
`--help`	Show help information
`--config <path>`	Specify config file location
`--debug`	Enable debug output
`--quiet`	Suppress output (except errors)

Commands

auth

Authenticate with the Quik Nodes platform.

quikdb-nodes auth [options]

Options

Option	Description	Default
`-t, --token <token>`	Authentication token from dashboard	Interactive prompt
`-e, --endpoint <url>`	Node agent endpoint URL	`http://localhost:3001`
`--skip-verification`	Skip endpoint verification	`false`

Examples

# Interactive authentication
quikdb-nodes auth

# With token
quikdb-nodes auth --token "cli_token_123"

Output

✅ Authentication successful!
   Token:     cli_token_***
   Endpoint:  https://api.quikdb.com
   Node ID:   node_8f3a9d2e1b5c4e7f
   Provider:  0xaBeBC628...A35c06

Configuration saved to ~/.quik-nodes/config.json

list

List your node as a provider in the marketplace.

quikdb-nodes list [options]

Options

Option	Description	Default
`-t, --type <type>`	Provider type (`compute`\|`storage`)	Interactive prompt
`--tier <tier>`	Node tier (`basic`\|`standard`\|`premium`\|`enterprise`)	Interactive prompt
`--auto-tier`	Automatically determine best tier	`false`
`--location <location>`	Geographic location	Interactive prompt
`--dry-run`	Validate without actually listing	`false`

Provider Types

compute: Provide computational resources for workloads
storage: Provide data storage and retrieval services

Tiers

Tier	CPU Cores	RAM (GB)	Storage (GB)	Bandwidth (Mbps)
`basic`	2+	8+	200+	50+
`standard`	4+	16+	500+	100+
`premium`	8+	32+	1000+	500+
`enterprise`	16+	64+	2000+	1000+

Examples

# Interactive listing
quikdb-nodes list

# Quick compute listing
quikdb-nodes list --type compute --tier standard --location "US-East"

# Auto-detect best tier
quikdb-nodes list --type compute --auto-tier --location "EU-West"

# Dry run (validation only)
quikdb-nodes list --type storage --tier premium --location "Asia" --dry-run

Output

🚀 List Node in Marketplace

✅ System validation passed
📋 Listing Preview:
   Provider Type: COMPUTE
   Tier:          STANDARD
   Location:      US-East
   CPU Cores:     8
   RAM:           32 GB
   Storage:       1000 GB
   Bandwidth:     1000 Mbps
   IOPS:          3000
   Node ID:       hostname-01

✅ Node listed successfully!
   Transaction Hash: 0xabcdef1234567890...
   Listing ID:       listing_8f3a9d2e1b5c4e7f

📝 Next steps:
   • Run "quikdb-nodes heartbeat --daemon" to maintain your listing
   • Run "quikdb-nodes status" to monitor your node status
   • Check the dashboard for marketplace visibility

validate

Validate system resources and tier eligibility.

quikdb-nodes validate [options]

Options

Option	Description	Default
`-t, --type <type>`	Provider type to validate against	`compute`
`--tier <tier>`	Specific tier to validate against	All tiers
`--all-tiers`	Check all tier requirements	`false`
`--detailed`	Show detailed resource breakdown	`false`

Examples

# Basic validation
quikdb-nodes validate

# Validate for specific tier
quikdb-nodes validate --tier premium --detailed

# Check all tiers
quikdb-nodes validate --all-tiers

# Storage provider validation
quikdb-nodes validate --type storage

Output

✅ System Validation Results

Provider Type: COMPUTE
Current System Specs:
   CPU Cores:       8
   RAM:             32 GB
   Storage:         1000 GB
   Bandwidth:       1000 Mbps
   IOPS:            3000
   GPU:             NVIDIA RTX 4090 (optional)
   Location:        US-East-1

Tier Compatibility:
   ✅ BASIC        Requirements met (exceeds minimum)
   ✅ STANDARD     Requirements met (exceeds minimum)
   ✅ PREMIUM      Requirements met
   ❌ ENTERPRISE   Insufficient CPU cores (need 16, have 8)

💡 Recommended Tier: PREMIUM
   Estimated earnings: 0.7-1.5 ETH/day

🔧 Optimization Suggestions:
   • Add 8 more CPU cores to qualify for ENTERPRISE tier
   • Consider SSD upgrade for better IOPS performance

status

Check node listing status and reputation.

quikdb-nodes status [options]

Options

Option	Description	Default
`--watch`	Continuously monitor status	`false`
`--reputation`	Show detailed reputation information	`false`
`--heartbeats`	Show recent heartbeat history	`false`
`--refresh <seconds>`	Refresh interval for watch mode	`30`

Examples

# Basic status
quikdb-nodes status

# Detailed status
quikdb-nodes status --reputation --heartbeats

# Continuous monitoring
quikdb-nodes status --watch

# Custom refresh rate
quikdb-nodes status --watch --refresh 60

Output

🏷️  Listing Information:
   Status:           ✅ ACTIVE
   Provider Type:    COMPUTE
   Tier:            STANDARD
   Listed Since:     2024-01-01
   Last Heartbeat:   2024-01-01 12:00:00 (2 min ago)
   Total Heartbeats: 1,440

💻 System Information:
   CPU Cores:        8
   RAM:             32 GB
   Storage:         1000 GB
   Bandwidth:       1000 Mbps
   Location:        US-East

🔗 Connection Status:
   Node Agent:       ✅ Connected
   Provider:         0xaBeBC628...A35c06

⭐ Reputation:
   Score:           95/100 (Excellent)
   Rank:            #47 of 1,250
   Success Rate:    98.5%
   Avg Response:    120ms
   Total Jobs:      150

💰 Earnings:
   Total:           45.8 ETH
   This Month:      3.2 ETH
   Last Payout:     2024-01-01 00:00:00

📊 Performance:
   Uptime:          99.8%
   CPU Usage:       65.2%
   Memory Usage:    78.5%
   Storage Usage:   45.3%

heartbeat

Send heartbeat to maintain node listing.

quikdb-nodes heartbeat [options]

Options

Option	Description	Default
`--daemon`	Run as background daemon	`false`
`--interval <seconds>`	Heartbeat interval in seconds	`300` (5 minutes)
`--stop`	Stop running heartbeat daemon	`false`
`--status`	Show daemon status	`false`

Examples

# Send single heartbeat
quikdb-nodes heartbeat

# Start heartbeat daemon
quikdb-nodes heartbeat --daemon

# Custom interval (2 minutes)
quikdb-nodes heartbeat --daemon --interval 120

# Check daemon status
quikdb-nodes heartbeat --status

# Stop daemon
quikdb-nodes heartbeat --stop

Output

# Single heartbeat
✅ Heartbeat sent successfully
   Health Score:     95/100
   CPU Usage:        65.2%
   Memory Usage:     78.5%
   Storage Usage:    45.3%
   Uptime:          99.8%
   Next due:        5 minutes

# Daemon mode
🔄 Starting heartbeat daemon...
   Interval:        5 minutes
   Process ID:      12345
   Log file:        ~/.quik-nodes/heartbeat.log

✅ Heartbeat daemon started successfully
   Use "quikdb-nodes heartbeat --stop" to stop
   Use "quikdb-nodes heartbeat --status" to check status

unlist

Remove node from marketplace listing.

quikdb-nodes unlist [options]

Options

Option	Description	Default
`-r, --reason <reason>`	Reason for unlisting	Interactive prompt
`--force`	Skip confirmation prompt	`false`

Examples

# Interactive unlisting
quikdb-nodes unlist

# With reason
quikdb-nodes unlist --reason "Hardware maintenance"

# Force unlisting (skip confirmation)
quikdb-nodes unlist --reason "Temporary shutdown" --force

Output

📤 Unlist Node from Marketplace

⚠️  Warning: This will remove your node from the marketplace.
   You will stop receiving new jobs immediately.
   Current jobs will continue to completion.

Reason: Hardware maintenance

Are you sure you want to unlist your node? (y/N): y

✅ Your node has been unlisted from the marketplace.
   Transaction Hash: 0xfedcba0987654321...

You can list your node again anytime using "quikdb-nodes list".

config

Manage CLI configuration.

quikdb-nodes config <command> [options]

Subcommands

show

Display current configuration.

quikdb-nodes config show

set

Set configuration value.

quikdb-nodes config set <key> <value>

reset

Reset configuration to defaults.

quikdb-nodes config reset

Examples

# Show configuration
quikdb-nodes config show

# Set endpoint
quikdb-nodes config set endpoint "https://api.quikdb.com"

# Set default provider type
quikdb-nodes config set defaultProviderType "compute"

# Reset configuration
quikdb-nodes config reset

Configuration Options

Key	Description	Default
`endpoint`	Node agent endpoint	`http://localhost:3001`
`token`	Authentication token	-
`defaultProviderType`	Default provider type	`compute`
`defaultLocation`	Default location	-
`heartbeatInterval`	Default heartbeat interval	`300`
`logLevel`	Logging level	`info`

logs

View CLI logs and debugging information.

quikdb-nodes logs [options]

Options

Option	Description	Default
`-f, --follow`	Follow log output	`false`
`-n, --lines <number>`	Number of lines to show	`50`
`--level <level>`	Filter by log level	All levels
`--clear`	Clear log files	`false`

Log Levels

error: Error messages only
warn: Warnings and errors
info: General information
debug: Detailed debugging information

Examples

# Show recent logs
quikdb-nodes logs

# Follow logs in real-time
quikdb-nodes logs --follow

# Show last 100 lines
quikdb-nodes logs --lines 100

# Show only errors
quikdb-nodes logs --level error

# Clear log files
quikdb-nodes logs --clear

info

Display system and CLI information.

quikdb-nodes info [options]

Options

Option	Description	Default
`--system`	Show system information	`true`
`--network`	Show network information	`false`
`--versions`	Show version information	`false`

Examples

# Basic info
quikdb-nodes info

# Detailed system info
quikdb-nodes info --system --network --versions

Output

🖥️  System Information:
   OS:              Linux Ubuntu 22.04.3 LTS
   Architecture:    x64
   CPU:             Intel(R) Xeon(R) CPU E5-2686 v4 @ 2.30GHz
   CPU Cores:       8
   RAM:             32 GB
   Storage:         1000 GB SSD
   Hostname:        node-provider-01

🌐 Network Information:
   Public IP:       203.0.113.15
   Location:        US-East-1
   ISP:             Amazon Web Services
   Bandwidth:       1000 Mbps

📦 Version Information:
   CLI Version:     1.0.0
   Node.js:         18.17.0
   npm:             9.6.7
   OS Version:      Ubuntu 22.04.3 LTS

🔧 Configuration:
   Config File:     ~/.quik-nodes/config.json
   Log File:        ~/.quik-nodes/app.log
   Endpoint:        https://api.quikdb.com
   Provider Type:   compute

Configuration File

The CLI stores configuration in ~/.quik-nodes/config.json:

{
  "version": "1.0.0",
  "endpoint": "https://api.quikdb.com",
  "token": "cli_token_encrypted_here",
  "nodeId": "node_8f3a9d2e1b5c4e7f",
  "provider": {
    "address": "0xaBeBC6283d1b32298D67c745da88DAD288A35c06",
    "type": "compute",
    "tier": "standard",
    "location": "US-East"
  },
  "settings": {
    "heartbeatInterval": 300,
    "logLevel": "info",
    "autoHeartbeat": true
  },
  "lastUpdated": "2024-01-01T12:00:00.000Z"
}

Environment Variables

Override configuration with environment variables:

Variable	Description	Example
`QUIK_NODE_ENDPOINT`	Node agent endpoint	`https://api.quikdb.com`
`QUIK_NODE_TOKEN`	Authentication token	`cli_token_123`
`QUIK_NODE_LOG_LEVEL`	Logging level	`debug`
`QUIK_NODE_CONFIG_DIR`	Configuration directory	`~/.quik-nodes`

# Use environment variables
export QUIK_NODE_ENDPOINT="http://localhost:3001"
export QUIK_NODE_LOG_LEVEL="debug"
quikdb-nodes status

Exit Codes

Code	Description
`0`	Success
`1`	General error
`2`	Authentication error
`3`	Validation error
`4`	Network error
`5`	Configuration error
`6`	System requirement error

Debugging

Enable Debug Mode

# Global debug flag
quikdb-nodes --debug status

# Environment variable
DEBUG=* quikdb-nodes status

# Specific modules
DEBUG=auth,websocket quikdb-nodes list

Log Files

Application logs: ~/.quik-nodes/app.log
Heartbeat logs: ~/.quik-nodes/heartbeat.log
Error logs: ~/.quik-nodes/error.log

Troubleshooting Commands

# Test connectivity
quikdb-nodes info --network

# Validate configuration
quikdb-nodes config show

# Check system requirements
quikdb-nodes validate --detailed

# View recent errors
quikdb-nodes logs --level error --lines 20

Scripting and Automation

Bash Script Example

#!/bin/bash
# automated-listing.sh

set -e

echo "Starting automated node listing..."

# Authenticate
quikdb-nodes auth --token "$CLI_TOKEN" --endpoint "$NODE_ENDPOINT"

# Validate system
if ! quikdb-nodes validate --type compute --tier standard; then
    echo "System validation failed"
    exit 1
fi

# List node
quikdb-nodes list --type compute --tier standard --location "US-East"

# Start heartbeat daemon
quikdb-nodes heartbeat --daemon --interval 300

echo "Node listing completed successfully"

Next Steps

Quick Deploy Guide - Get started with node deployment
Framework Configuration - Framework-specific setup guides
Advanced Configuration - Advanced configuration options
Platform Architecture - Understanding the platform architecture

Installation​

Global Options​

Commands​

auth​

Options​

Examples​

Output​

list​

Options​

Provider Types​

Tiers​

Examples​

Output​

validate​

Options​

Examples​

Output​

status​

Options​

Examples​

Output​

heartbeat​

Options​

Examples​

Output​

unlist​

Options​

Examples​

Output​

config​

Subcommands​

show​

set​

reset​

Examples​

Configuration Options​

logs​

Options​

Log Levels​

Examples​

info​

Options​

Examples​

Output​

Configuration File​

Environment Variables​

Exit Codes​

Debugging​

Enable Debug Mode​

Log Files​

Troubleshooting Commands​

Scripting and Automation​

Bash Script Example​

Next Steps​

Installation

Global Options

Commands

auth

Options

Examples

Output

list

Options

Provider Types

Tiers

Examples

Output

validate

Options

Examples

Output

status

Options

Examples

Output

heartbeat

Options

Examples

Output

unlist

Options

Examples

Output

config

Subcommands

show

set

reset

Examples

Configuration Options

logs

Options

Log Levels

Examples

info

Options

Examples

Output

Configuration File

Environment Variables

Exit Codes

Debugging

Enable Debug Mode

Log Files

Troubleshooting Commands

Scripting and Automation

Bash Script Example

Next Steps