Skip to content

CODESPACE.md

Latest commit

 

History

History
56 lines (36 loc) · 2.2 KB

CODESPACE.md

File metadata and controls

56 lines (36 loc) · 2.2 KB

❔ About

GitHub Codespaces provides a complete, cloud-based development environment that lets you work on geol from anywhere, without needing to install anything locally. This is perfect for trying out geol, contributing to the project, or just playing with it in a comfortable way.

The geol repository is configured to automatically install geol when you create a Codespace, so you can start using it immediately!

🚀 Quickstart

Launch a Codespace with geol pre-installed

  1. Navigate to the geol repository
  2. Click the green Code button
  3. Select the Codespaces tab
  4. Click Create codespace on main (or your desired branch)

GitHub will create a cloud-based development environment and automatically install geol using the installation script.

Verify geol is ready

Once your Codespace has finished building (wait for the post-create command to complete), verify that geol is installed:

geol version

Start using geol

geol help

That's it! No manual installation required. 🎉

🛠️ How it works

The repository includes a .devcontainer/devcontainer.json configuration file that:

  1. Sets up an Ubuntu 24.04 development environment (includes GLIBC 2.39 for binary compatibility)
  2. Automatically runs the install.sh script during Codespace creation to install the latest prebuilt geol binary
  3. Adds geol to your PATH

This means geol is ready to use as soon as your Codespace is created!

💡 Tips

  • Your Codespace persists your changes, so you can close and reopen it later
  • Codespaces are free for personal accounts (up to 60 hours/month for free tier)
  • You can customize your Codespace environment by editing .devcontainer/devcontainer.json
  • The Codespace comes with Go, Git, and GitHub CLI pre-installed

📑 Related resources