Getting Started
Getting Started
This page walks through your first Codespace end to end.
Before you begin
If access is not already approved, complete Prerequisites and Access first.
Option A: use Codespaces in the browser
- Go to the repository you want to work on in GitHub.
- Select Code.
- Open the Codespaces tab.
- Choose Create codespace on main, or pick another branch.
GitHub's guide Creating a codespace for a repository covers this in more depth.
Opening a terminal in the browser
- Keyboard: Ctrl+
(Windows/Linux) or Cmd+(macOS) - Menu: View, then Terminal
Option B: use Codespaces in VS Code
- Install VS Code if needed: Download VS Code
- Install the extension: GitHub Codespaces extension
- Open the Command Palette in VS Code.
- Run Codespaces: Connect to Codespace.
- Sign in and select your Codespace.
For more, see Developing in a codespace.
Opening a terminal in VS Code
- Keyboard: Ctrl+
(Windows/Linux) or Cmd+(macOS) - Menu: Terminal, then New Terminal
First-day checklist
- Confirm you can clone or open the target repository
- Run dependency install commands for your project
- Run tests or linters once
- Commit and push a small change
- Stop the Codespace when finished
Related links
Was this page useful?