Skip to content

02a-setup-codespace.md

Latest commit

 

History

History
86 lines (57 loc) · 3.16 KB

02a-setup-codespace.md

File metadata and controls

86 lines (57 loc) · 3.16 KB
Raw

Set Up a Codespace

🎯 What You'll Do

You'll launch a GitHub Codespace for this workshop, open the built-in terminal, and land in a ready-to-use environment for the next step.

Steps

Verify you are on the right path before continuing:

  • You have a GitHub account with access to GitHub Codespaces
  • You want a browser-based terminal and do not need to install tools locally

These steps take about 5 minutes. If you get stuck on any command, Side Quest: Terminal Basics is a 2-minute read.

New repository

  1. Create your own public repository at github.com/new:
    • Choose yourself as owner.
    • Visibility Private, it's good to learn on our own. We can make it public later if we want to share our work.
    • Name it my-agentic-workflows.
    • Check Add a README file.
    • Click Create repository.

Open the Codespace

  1. In your new repository, click the green Code button.
  2. Click the Codespaces tab.
    • Leave main selected as the branch.
    • Click Create codespace on main.
    • Wait 30–60 seconds for GitHub to prepare the container and open the editor.

Open Codespace

Codespaces auto-save your work. If you close the tab, open github.com/codespaces to resume where you left off.

Open the Codespace terminal

  1. When the Codespace editor loads, open the built-in terminal with Ctrl+` (or Cmd+Option+` on Mac).
  2. Wait for the terminal prompt to appear.
  3. Keep this terminal open. It is already inside your practice repository.

Tip

If the terminal in your Codespace shows a $ prompt, the container is ready. If you see an error, see install troubleshooting.

First time in a terminal?

Type your command after the $ prompt and press Enter. Output appears below; a new $ prompt means the command finished. See Side Quest: Terminal Basics for more.

Verify your Codespace is ready

The diagram below shows your Codespace connection to GitHub.

Codespace environment architecture: your browser connects to a cloud container with pre-installed tools, which communicates with GitHub

  1. Run these commands in the Codespace terminal:

    gh --version

  2. Confirm gh --version shows gh version 2.40.0 or newer.

What success looks like:

gh version 2.40.0 (2024-01-01)

You should see gh version 2.40.0 or newer and a line confirming you're logged in to github.com.

✅ Checkpoint

  • You confirmed your GitHub plan includes Codespaces access (free for public repositories)
  • The Codespace editor is open in your browser
  • The built-in terminal is open in your Codespace
  • gh --version returns version 2.40.0 or newer
  • The Codespace is attached to your my-agentic-workflows practice repository

Next: GitHub Actions Intro