gh-setup

command module
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2023 License: MIT Imports: 4 Imported by: 0

README

gh-setup

✨ A GitHub (gh) CLI extension to setup new repositories.

Installation

  1. Install the gh CLI - see the installation

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

  2. Install this extension:

    gh extension install twelvelabs/gh-setup
    

Usage

Navigate to the repo you would like to setup and run:

gh setup

This will:

  • Ensure your local repo has been created:
    • git init
    • git add .
    • git commit -m "Initial commit"
  • Ensure your remote repo has been created:
    • gh repo create --source=. --push

The extension was designed to be run directly after scaffolding out a new project, but is idempotent (so is safe to run at any time). Each step is only run if needed and prompts before taking action.

Development

Local development requires Go 1.19:

brew install go
# Or install manually: https://go.dev/doc/install

Then:

git clone git@github.com:twelvelabs/gh-setup.git
cd ./gh-setup

make setup
make build
make install

# For more tasks
make help

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
cmd
gh
git

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL