Skip to Content
New to Genbox? Check out our Getting Started guide
Commandsdoctor

gb doctor

Check CLI setup and diagnose issues.

Synopsis

gb doctor [options]

Description

Runs diagnostic checks on your Genbox CLI installation, configuration, and connectivity. Helps identify and fix common issues.

Options

OptionDescription
--fixAttempt to fix detected issues
--verboseShow detailed diagnostic output

Examples

Run Diagnostics

gb doctor

Fix Issues

gb doctor --fix

Verbose Output

gb doctor --verbose

Diagnostic Output

Healthy System

Genbox Doctor

Checking CLI setup...

  ✓ Node.js version     v20.10.0 (required: ≥18)
  ✓ CLI version         1.0.135 (latest)
  ✓ npm global install  /usr/local/bin/genbox

Checking authentication...

  ✓ Logged in           alice@example.com
  ✓ Token valid         expires in 28 days
  ✓ SSH key             ~/.ssh/genbox_ed25519

Checking connectivity...

  ✓ API reachable       https://api.genbox.dev (45ms)
  ✓ SSH reachable       ssh.genbox.dev:22

Checking project...

  ✓ genbox.yaml         found
  ✓ Configuration       valid
  ✓ Git repository      clean

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
All checks passed! ✓

With Issues

Genbox Doctor

Checking CLI setup...

  ✓ Node.js version     v20.10.0 (required: ≥18)
  ✗ CLI version         1.0.130 (outdated, latest: 1.0.135)
  ✓ npm global install  /usr/local/bin/genbox

Checking authentication...

  ✓ Logged in           alice@example.com
  ⚠ Token expiring      expires in 3 days
  ✗ SSH key             not found

    Run 'gb login' to regenerate SSH key

Checking connectivity...

  ✓ API reachable       https://api.genbox.dev (45ms)
  ✓ SSH reachable       ssh.genbox.dev:22

Checking project...

  ✓ genbox.yaml         found
  ✗ Configuration       2 errors

    Run 'gb validate' for details

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Found 3 issues (1 warning, 2 errors)

Run 'gb doctor --fix' to attempt automatic fixes.

Checks Performed

CLI Setup

  • Node.js version (≥18 required)
  • CLI version (outdated check)
  • Installation location

Authentication

  • Login status
  • Token validity
  • SSH key presence

Connectivity

  • API endpoint reachable
  • SSH port accessible
  • Network latency

Project

  • genbox.yaml exists
  • Configuration valid
  • Git status

Auto-Fix

--fix can automatically:

  • Update outdated CLI
  • Regenerate SSH keys
  • Refresh expired tokens
  • Fix common config issues

Notes

  • Run when experiencing issues
  • --fix is safe to run
  • Some fixes require gb login
  • Share output when seeking support

See Also

Last updated on
helpupdate