https://github.com/albingroen/gh-butler

A github/git automation tool
https://github.com/albingroen/gh-butler

automation github github-api script tool

Last synced: about 2 months ago
JSON representation

A github/git automation tool

• Host: GitHub
• URL: https://github.com/albingroen/gh-butler
• Owner: albingroen
• Created: 2019-08-29T21:10:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T00:35:48.000Z (about 2 years ago)
• Last Synced: 2024-05-01T15:17:41.437Z (8 months ago)
• Topics: automation, github, github-api, script, tool
• Language: JavaScript
• Homepage: https://github.com/albingroen/gh-butler
• Size: 67.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# Github Butler 🥄



> A github/git automation tool

A automation tool for creating GitHub & Git projects that lets you get up and running with actually coding in notime instead of spending time on creating a repo, cloning the repo, opening in VSCode etc.

![gh-butler demo video](https://res.cloudinary.com/albin-groen/image/upload/v1567237228/gh-butler-demo.gif "gh-butler demo video")

## How it works

1.  **Run the wizard**

        gh-butler     

1.5. **Enter Github repo level access token**

The first time you run the command it will ask you for your Github Repo level access token. Fetch it from Github in the developer settings and enter it after the question. This will only be stored in a local file and you'll not have to enter it again as long as you don't delete the file.

2.  **Answer questions**

    - _Name_:

    - _Description_:

    - _Public or Private_:

    - _Use template_:

3.  **Start coding**

## Installation

1.  **Clone repository**

        git clone [email protected]:albingroen/gh-butler.git

2.  **Install dependencies**

        npm install

        # or use yarn

        yarn

3.  **Add a global alias to `~/.zshrc`** (_or similar for bash_)

        alias gh-butler="node PATH_TO_FOLDER/script.js"

4.  **Source your zsh configuration** (_or similar for bash_)

        source ~/.zshrc

## Templates

- React.js

- Node.js

- Node.js + Express

- Link to any template you wish to use

## Contributors

[Albin Groen](https://github.com/albingroen)