Scroll to navigation

GH-CODESPACE-VIEW(1) GitHub CLI manual GH-CODESPACE-VIEW(1)

NAME

gh-codespace-view - View details about a codespace

SYNOPSIS

gh codespace view [flags]

OPTIONS

Name of the codespace

Filter JSON output using a jq expression

Output JSON with the specified fields

Filter codespace selection by repository name (user/repo)

Filter codespace selection by repository owner (username or org)

Format JSON output using a Go template; see "gh help formatting"

JSON FIELDS

billableOwner, createdAt, devcontainerPath, displayName, environmentId, gitStatus, idleTimeoutMinutes, lastUsedAt, location, machineDisplayName, machineName, name, owner, prebuild, recentFolders, repository, retentionExpiresAt, retentionPeriodDays, state, vscsTarget

EXAMPLE

# select a codespace from a list of all codespaces you own
$ gh cs view	
# view the details of a specific codespace
$ gh cs view -c codespace-name-12345
# view the list of all available fields for a codespace
$ gh cs view --json
# view specific fields for a codespace
$ gh cs view --json displayName,machineDisplayName,state

SEE ALSO

gh-codespace(1)

Jul 2024 GitHub CLI v2.52.0