Guides for Codespaces
Learn how to make the most of GitHub
Quickstart for GitHub Codespaces
QuickstartTry out GitHub Codespaces in 5 minutes.
- Codespaces
Deep dive into GitHub Codespaces
QuickstartUnderstand how GitHub Codespaces works.
- Codespaces
Introduction to dev containers
How-to guideWhen you work in a codespace, the environment you are working in is created using a development container, or dev container, hosted on a virtual machine.
- Codespaces
- Set up
- Fundamentals
Setting up a Node.js project for GitHub Codespaces
TutorialGet started with a Node.js, JavaScript, or TypeScript project in GitHub Codespaces by creating a custom dev container configuration.
- Codespaces
- Developer
- Set up
Setting up a Python project for GitHub Codespaces
TutorialGet started with a Python project in GitHub Codespaces by creating a custom dev container configuration.
- Codespaces
- Developer
- Set up
Setting up a C# (.NET) project for GitHub Codespaces
TutorialGet started with a C# (.NET) project in GitHub Codespaces by creating a custom dev container configuration.
- Codespaces
- Developer
- Set up
Setting up a Java project for GitHub Codespaces
TutorialGet started with a Java project in GitHub Codespaces by creating a custom dev container configuration.
- Codespaces
- Developer
- Set up
Setting up a PHP project for GitHub Codespaces
TutorialGet started with a PHP project in GitHub Codespaces by creating a custom dev container configuration.
- Codespaces
- Developer
- Set up
Setting a minimum specification for codespace machines
How-to guideYou can avoid under-resourced machine types being used for GitHub Codespaces for your repository.
- Codespaces
- Set up
Adding features to a devcontainer.json file
How-to guideWith features, you can quickly add tools, runtimes, or libraries to your dev container configuration.
- Codespaces
- Set up
Automatically opening files in the codespaces for a repository
How-to guideYou can set particular files to be opened automatically whenever someone creates a codespace for your repository and opens the codespace in the Visual Studio Code web client.
- Codespaces
- Set up
Specifying recommended secrets for a repository
How-to guideYou can add a setting to your dev container configuration that will prompt people to set specific development environment secrets when they create a codespace.
- Codespaces
- Set up
Facilitating quick creation and resumption of codespaces
How-to guideYou can add a link to take people straight to a page for creating a codespace, with your choice of options preconfigured. Alternatively you can link to the "Resume codespace" page.
- Codespaces
- Set up
Setting up a template repository for GitHub Codespaces
How-to guideYou can help people get started with a project by setting up a template repository for use with GitHub Codespaces.
- Codespaces
- Set up
Personalizing GitHub Codespaces for your account
How-to guideYou can personalize GitHub Codespaces by using a dotfiles repository on GitHub or by using Settings Sync.
- Codespaces
- Set up
- Fundamentals
Creating a codespace for a repository
How-to guideYou can create a codespace for a branch in a repository to develop online.
- Codespaces
- Fundamentals
- Developer
Creating a codespace from a template
How-to guideIf you're starting a new project, you can create a codespace from a blank template or choose a template specially designed for the type of work you want to do.
- Codespaces
- Fundamentals
- Developer
Developing in a codespace
How-to guideYou can work in a codespace using your browser, Visual Studio Code, a JetBrains IDE, or in a command shell.
- Codespaces
- Fundamentals
- Developer
Deleting a codespace
How-to guideYou can delete a codespace you no longer need.
- Codespaces
- Fundamentals
- Developer
Forwarding ports in your codespace
How-to guideYou can forward ports in your codespace to test and debug your application. You can also manage the port protocol and share the port within your organization or publicly.
- Codespaces
- Fundamentals
- Developer