table of contents
GH-CODESPACE-CREATE(1) | GitHub CLI manual | GH-CODESPACE-CREATE(1) |
NAME¶
gh-codespace-create - Create a codespace
SYNOPSIS¶
gh codespace create [flags]
OPTIONS¶
- -b, --branch <string>
- repository branch
- --default-permissions
- do not prompt to accept additional permissions requested by the codespace
- --devcontainer-path <string>
- path to the devcontainer.json file to use when creating codespace
- -d, --display-name <string>
- display name for the codespace (48 characters or less)
- --idle-timeout <duration>
- allowed inactivity before codespace is stopped, e.g. "10m", "1h"
- -l, --location <string>
- location: {EastUs|SouthEastAsia|WestEurope|WestUs2} (determined automatically if not provided)
- -m, --machine <string>
- hardware specifications for the VM
- -R, --repo <string>
- repository name with owner: user/repo
- --retention-period <duration>
- allowed time after shutting down before the codespace is automatically deleted (maximum 30 days), e.g. "1h", "72h"
- -s, --status
- show status of post-create command and dotfiles
- -w, --web
- create codespace from browser, cannot be used with --display-name, --idle-timeout, or --retention-period
EXIT CODES¶
0: Successful execution
1: Error
2: Command canceled
4: Authentication required
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.
SEE ALSO¶
Nov 2024 | GitHub CLI v2.62.0 |