.nh
.TH "GH-CODESPACE-VIEW" "1" "May 2024" "" "GitHub CLI manual"

.SH NAME
.PP
gh-codespace-view - View details about a codespace


.SH SYNOPSIS
.PP
\fBgh codespace view [flags]\fR


.SH OPTIONS
.TP
\fB-c\fR, \fB--codespace\fR \fB<string>\fR
Name of the codespace

.TP
\fB-q\fR, \fB--jq\fR \fB<expression>\fR
Filter JSON output using a jq expression

.TP
\fB--json\fR \fB<fields>\fR
Output JSON with the specified fields

.TP
\fB-R\fR, \fB--repo\fR \fB<string>\fR
Filter codespace selection by repository name (user/repo)

.TP
\fB--repo-owner\fR \fB<string>\fR
Filter codespace selection by repository owner (username or org)

.TP
\fB-t\fR, \fB--template\fR \fB<string>\fR
Format JSON output using a Go template; see "gh help formatting"


.SH JSON FIELDS
.PP
\fBbillableOwner\fR, \fBcreatedAt\fR, \fBdevcontainerPath\fR, \fBdisplayName\fR, \fBenvironmentId\fR, \fBgitStatus\fR, \fBidleTimeoutMinutes\fR, \fBlastUsedAt\fR, \fBlocation\fR, \fBmachineDisplayName\fR, \fBmachineName\fR, \fBname\fR, \fBowner\fR, \fBprebuild\fR, \fBrecentFolders\fR, \fBrepository\fR, \fBretentionExpiresAt\fR, \fBretentionPeriodDays\fR, \fBstate\fR, \fBvscsTarget\fR


.SH EXAMPLE
.EX
# 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

.EE


.SH SEE ALSO
.PP
\fBgh-codespace(1)\fR