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

gb status

Check the status of a Genbox environment.

Synopsis

gb status [name] [options]

Description

Shows detailed status information about a Genbox environment, including services, health checks, and resource usage.

Arguments

ArgumentDescription
nameOptional. Environment name. If not provided, shows status of current/default environment.

Options

OptionDescription
-w, --watchWatch mode - continuously update status
--jsonOutput as JSON
-v, --verboseShow detailed service information

Examples

Basic Status

gb status feature-auth

Output:

Genbox: feature-auth Status: running Size: medium (4 vCPU, 8GB RAM) Age: 2 hours ago Services: ✓ admin running https://admin.feature-auth.genbox.dev ✓ api running https://api.feature-auth.genbox.dev ✓ mongodb running port 27017 ✓ redis running port 6379 Database: copy from staging (1.2 GB) Auto-destroy: in 56 minutes (extend with 'gb extend')

Watch Mode

gb status -w

Continuously updates every 5 seconds. Useful during:

  • Environment creation
  • Service restarts
  • Debugging issues

Verbose Output

gb status -v

Shows additional details:

  • PM2 process IDs
  • Memory usage per service
  • CPU usage
  • Uptime
  • Restart count
  • Log file locations

JSON Output

gb status --json
{ "name": "feature-auth", "status": "running", "size": "medium", "services": [ { "name": "admin", "status": "running", "url": "https://admin.feature-auth.genbox.dev", "health": "healthy", "memory": "128MB", "cpu": "2%" } ], "infrastructure": [ { "name": "mongodb", "status": "running", "port": 27017 } ], "auto_destroy_at": "2024-12-24T12:00:00Z" }

Status Indicators

IconMeaning
Service healthy and running
Service starting
Service failed or unhealthy
Service restarting
?Status unknown

Health Check Details

Services with configured health checks show:

  • Response time
  • Last check time
  • Consecutive failures
✓ api running https://api.feature-auth.genbox.dev health: 200 OK (45ms) - checked 10s ago

Setup Progress

During creation, shows setup progress:

Genbox: feature-auth Status: starting (3/7 steps) ✓ Server provisioned ✓ Repositories cloned ✓ Dependencies installed ○ Database syncing... 45% · Starting services · Running health checks · Ready

Notes

  • Watch mode exits automatically when environment is ready
  • Use --json for scripting and automation
  • Status updates every 5 seconds in watch mode

See Also

Last updated on