https://github.com/hubwriter/gh-quickcs
Quickly create a codespace for a preconfigured repo from your terminal.
https://github.com/hubwriter/gh-quickcs
cli codespaces gh-extension terminal
Last synced: 21 days ago
JSON representation
Quickly create a codespace for a preconfigured repo from your terminal.
- Host: GitHub
- URL: https://github.com/hubwriter/gh-quickcs
- Owner: hubwriter
- Created: 2023-01-31T08:50:45.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-30T12:22:32.000Z (about 2 years ago)
- Last Synced: 2024-05-02T03:25:47.522Z (almost 2 years ago)
- Topics: cli, codespaces, gh-extension, terminal
- Language: Shell
- Homepage:
- Size: 172 KB
- Stars: 21
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-gh-extensions - hubwriter/gh-quickcs - 12-18 | Quickly create a codespace for a preconfigured repo from your terminal. | (🧩 Categories / UI / Dashboard)
README
# 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](https://github.com/cli/cli#installation)
_Installation requires a minimum version (2.0.0) of the the GitHub CLI that supports extensions._
1. 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
```sh
gh quickcs
```
1. _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.
1. 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.
1. _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
## ⭐ 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.