Skip to main content

Command Reference

All QuikDB commands you can use.

Basic Commands​

Get Help​

quikdb help

Check Version​

quikdb --version

Update Commands​

Check for Updates​

# Check if updates are available
quikdb update --check

# Check with different channel
quikdb update --check --channel beta

Install Updates​

# Interactive update
quikdb update

# Force update without confirmation
quikdb update --force

# Update to beta releases
quikdb update --channel beta

The update system preserves your configuration and automatically backs up the current binary.

Device Commands​

Register Your Computer​

quikdb device register

This will ask for a username and password, then connect your computer to QuikDB.

Check Status​

quikdb device status

Shows if your computer is connected and earning.

Control the Service​

Start the background service:

quikdb device heartbeat start

Stop the background service:

quikdb device heartbeat stop

Check if it's running:

quikdb device heartbeat status

Auto-Start Service Commands​

# Install auto-start (runs on boot)
quikdb service install

# Check status
quikdb service status

# Uninstall
quikdb service uninstall

Works on macOS, Linux, and Windows.

Uninstall Commands​

Complete Removal​

# Preview what will be removed
quikdb uninstall --dry-run

# Remove QuikDB completely
quikdb uninstall

# Skip confirmation prompts
quikdb uninstall --force

Preserve Data​

# Keep your registration data
quikdb uninstall --keep-config

# Keep log files for troubleshooting
quikdb uninstall --keep-logs

# Combine options
quikdb uninstall --keep-config --keep-logs

The uninstall command safely removes:

  • All running QuikDB processes
  • Auto-start services
  • Configuration files (unless --keep-config)
  • Platform-specific service files

Tunnel Commands​

Check tunnel status:

quikdb device tunnel status

Request a new tunnel:

quikdb device tunnel request

Referral Commands​

Generate Your Code​

quikdb referral generate

View Referral Stats​

quikdb referral status

Apply a Referral Code​

During registration:

quikdb device register --referral-code CODE

After registration:

quikdb referral apply CODE

See the Referral System Guide for details.

Web Dashboard​

Open http://localhost:4222 to see:

  • Connection status and uptime
  • Earnings and ranking
  • Live system metrics

Uptime persists across restarts.

Common Usage​

Setup:

quikdb device register
quikdb service install

Check status:

quikdb device status

Restart if needed:

quikdb device heartbeat stop
quikdb device heartbeat start