Skip to content

Quickly create a codespace for a preconfigured repo from your terminal.

Notifications You must be signed in to change notification settings

hubwriter/gh-quickcs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 

Repository files navigation

gh-quickcs

A GitHub CLI extension that lets you quickly create a new codespace for a preconfigured repository.

📦 Installation

  1. If you haven't already, install the gh CLI - see the installation

    Installation requires a minimum version (2.0.0) of the the GitHub CLI that supports extensions.

  2. Use the GitHub CLI to install the extension:

    gh ext install hubwriter/gh-quickcs
    
    Cloning into '/Users/yourname/.local/share/gh/extensions/gh-quickcs'...
    remote: Enumerating objects: 35, done.
    remote: Counting objects: 100% (35/35), done.
    remote: Compressing objects: 100% (30/30), done.
    remote: Total 35 (delta 6), reused 24 (delta 3), pack-reused 0
    Receiving objects: 100% (35/35), 9.65 KiB | 4.83 MiB/s, done.
    Resolving deltas: 100% (6/6), done.
    ✓ Installed extension hubwriter/gh-quickcs
    

⚡️ Usage

  1. Run

    gh quickcs
  2. On first run only: The first time you use the extension it will ask you to input configuration options. This is a one-time operation. The values you enter are stored in ~/.gh-quickcs.cfg. You can edit this file if you need to change the values, but the rationale of this script is that you want to create the same kind of codespace for the same repository, so you won't need to change these values once you've set them.

  3. Enter a display name for the codespace you want to create. Don't use quote marks around the name. The name can include spaces and hyphens.

  4. Optionally (depending on whether you set true or false for the REQUEST_BRANCH config setting): Enter the name of a new branch you want to create, or press Enter to use the default branch.

Example

image

⭐ If you like it, star it!

If you like this CLI extension, please star the repo by clicking ☆ Star top right of this page.

This helps raise the profile of this extension. Thanks.

About

Quickly create a codespace for a preconfigured repo from your terminal.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages