codespaces

GitHub Codespaces Utilities

Utility for adding better project support for GitHub Codespaces.

Welcome to the codespaces repository. This package simply gives a couple functions for accessing to GitHub Codespaces related information. It can help you add better project support for GitHub codespaces, especially pertaining to either side of applications which are not fully contained.

Installation   ·   Usage

---

Installation

npm install codespaces

Usage

import { getCodespacesTunnelUrl } from "codespaces";

// Get the current GitHub Codespaces tunnel URL at a specific port.
const url = getCodespacesTunnelUrl({ port: 2000 });
console.log(url); // https://ridafkih-code...-2000.githubpreview.dev

import { getCodespacesEnvironment } from "codespaces";

// Get general JSON information about the current GitHub Codespaces
const environment = getCodespacesEnvironment();
console.log(environment); // { isCodespaces: true, ...