# README
gh-setup
:sparkles: A GitHub (gh
) CLI extension to setup new repositories.
Installation
-
Install the
gh
CLI - see the installationInstallation requires a minimum version (2.0.0) of the the GitHub CLI that supports extensions.
-
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 [email protected]:twelvelabs/gh-setup.git
cd ./gh-setup
make setup
make build
make install
# For more tasks
make help