Skip to main content

Default environment variables for your codespace

GitHub sets default environment variables for each codespace.

GitHub Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. GitHub Codespaces is also available as a limited beta release for individual users on GitHub Free and GitHub Pro plans. For more information, see "GitHub's products."

About default environment variables

GitHub sets default environment variables for every codespace. Commands run in codespaces can create, read, and modify environment variables.

Note: Environment variables are case-sensitive.

List of default environment variables

Environment variableDescription
CODESPACE_NAMEThe name of the codespace For example, monalisa-github-hello-world-2f2fsdf2e
CODESPACESAlways true while in a codespace
GIT_COMMITTER_EMAILThe email for the "author" field of future git commits.
GIT_COMMITTER_NAMEThe name for the "committer" field of future git commits.
GITHUB_API_URLReturns the API URL. For example,
GITHUB_GRAPHQL_URLReturns the GraphQL API URL. For example,
GITHUB_REPOSITORYThe owner and repository name. For example, octocat/Hello-World.
GITHUB_SERVER_URLReturns the URL of the GitHub Enterprise Cloud server. For example,
GITHUB_TOKENA signed auth token representing the user in the codespace. You can use this to make authenticated calls to the GitHub API. For more information, see "Authentication."
GITHUB_USERThe name of the user that initiated the codespace. For example, octocat.