1
0
mirror of synced 2025-12-19 18:10:59 -05:00
Files
docs/content/codespaces/developing-in-a-codespace/default-environment-variables-for-your-codespace.md
2023-10-24 11:33:45 +00:00

2.1 KiB

title, shortTitle, intro, versions, type, topics, redirect_from
title shortTitle intro versions type topics redirect_from
Default environment variables for your codespace Default environment variables {% data variables.product.prodname_dotcom %} sets default environment variables for each codespace.
fpt ghec
* *
overview
Codespaces
Fundamentals
Developer
/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace

About default environment variables

{% data variables.product.prodname_dotcom %} sets default environment variables for every codespace. Commands run in codespaces can create, read, and modify environment variables.

{% note %}

Note: Environment variables are case-sensitive.

{% endnote %}

List of default environment variables

Environment variable Description
CODESPACE_NAME The name of the codespace For example, octocat-literate-space-parakeet-mld5
CODESPACES Always true while in a codespace
GIT_COMMITTER_EMAIL The email for the "author" field of future git commits.
GIT_COMMITTER_NAME The name for the "committer" field of future git commits.
GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN Returns the domain of the {% data variables.product.prodname_github_codespaces %} forwarded port. For example, app.github.dev.
GITHUB_API_URL Returns the API URL. For example, {% data variables.product.api_url_code %}.
GITHUB_GRAPHQL_URL Returns the GraphQL API URL. For example, {% data variables.product.graphql_url_code %}.
GITHUB_REPOSITORY The owner and repository name. For example, octocat/Hello-World.
GITHUB_SERVER_URL Returns the URL of the {% data variables.product.product_name %} server. For example, https://{% data variables.product.product_url %}.
GITHUB_TOKEN A 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 "AUTOTITLE."
GITHUB_USER The name of the user that initiated the codespace. For example, octocat.