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

gb list

List all your Genbox environments.

Synopsis

gb list [options]
gb ls [options]

Description

Shows all environments associated with your account, including their status, age, and configuration.

Options

OptionDescription
--allShow all environments (including destroyed)
--jsonOutput as JSON
-q, --quietOnly show environment names

Examples

Basic Listing

gb list

Output:

Your Genboxes:

  NAME            STATUS     AGE      SIZE    APPS
  feature-auth    running    2h ago   medium  admin, api
  bugfix-login    running    1d ago   small   admin
  experiment      stopped    3d ago   small   web

  3 environments (2 running, 1 stopped)

Quiet Mode

gb list -q

Output:

feature-auth
bugfix-login
experiment

JSON Output

gb list --json
{
  "environments": [
    {
      "name": "feature-auth",
      "status": "running",
      "size": "medium",
      "apps": ["admin", "api"],
      "created_at": "2024-12-24T10:00:00Z",
      "urls": {
        "admin": "https://admin.feature-auth.genbox.dev",
        "api": "https://api.feature-auth.genbox.dev"
      }
    }
  ]
}

Show All Including Destroyed

gb list --all

Status Values

StatusDescription
runningEnvironment is active and accessible
startingEnvironment is being created
stoppingEnvironment is being paused
stoppedEnvironment is paused (can be resumed)
destroyingEnvironment is being deleted
errorEnvironment encountered an error

See Also

Last updated on
newdestroy