https://github.com/timmikeladze/github-issue-to-branch

🎋 CLI tool to quickly create well-named branches from GitHub issues.
https://github.com/timmikeladze/github-issue-to-branch

bash branch gh git github issue-to-branch issues

Last synced: 2 months ago
JSON representation

🎋 CLI tool to quickly create well-named branches from GitHub issues.

• Host: GitHub
• URL: https://github.com/timmikeladze/github-issue-to-branch
• Owner: TimMikeladze
• License: mit
• Created: 2024-05-14T20:11:30.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-10-08T11:01:44.000Z (3 months ago)
• Last Synced: 2024-10-12T20:34:46.412Z (3 months ago)
• Topics: bash, branch, gh, git, github, issue-to-branch, issues
• Language: TypeScript
• Homepage:
• Size: 81.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🎋 GitHub Issue to Branch

CLI tool to quickly create well-named branches from GitHub issues. 

> 👋 Hello there! Follow me [@linesofcode](https://twitter.com/linesofcode) or visit [linesofcode.dev](https://linesofcode.dev) for more cool projects like this one.

## 🚀 Getting Started

```console

npm install -g github-issue-to-branch

pnpm add -g github-issue-to-branch

yarn global add github-issue-to-branch

```

> ⚠️ Prerequisites: You need to have `git` and `gh` ([Github CLI](https://github.com/cli/cli)) installed on your machine.

## 📖 Usage

Simply run the `ghib` command with the issue number(s) you want to create a branch from.

The command will create a new branch with the name in the following format: `-`.

```console

ghib 1234

```

```console

Usage: github-issue-to-branch  [...] []

   or: ghib  [...] []

Create a Git branch from one or more GitHub issue numbers.

Arguments:

    One or more GitHub issue numbers

         Optional postfix to add to the branch name

Examples:

  github-issue-to-branch 123 456

  ghib 789 quick-fix  # 'quick-fix' is an optional postfix

Note: The postfix is entirely optional. It can be used for any additional context

you want to add to your branch name, such as 'quick-fix', 'wip', or even your initials.

```