# gitbuddy

> The best git friend you've ever had.

Latest version **5.2.11** (published 2023-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install gitbuddy
pnpm add gitbuddy
yarn add gitbuddy
bun add gitbuddy
```

Provides the command `gitbuddy`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.2.11 |
| Published | 2023-04-05 |
| First published | 2020-06-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 30.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Josh Levy |
| Maintainers | joshaaronlevy |
| Keywords | git, cli, vcs, command, utility, helper, terminal, branch management |

## Links

- npm: https://www.npmjs.com/package/gitbuddy
- Repository: https://github.com/JoshAaronLevy/gitbuddy
- Homepage: https://github.com/JoshAaronLevy/gitbuddy#readme
- Issues: https://github.com/JoshAaronLevy/gitbuddy/issues
- npm.io page: https://npm.io/package/gitbuddy

## Dependencies (6)

- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [colorette](https://npm.io/package/colorette.md) ^2.0.19
- [commander](https://npm.io/package/commander.md) ^3.0.2
- [nanospinner](https://npm.io/package/nanospinner.md) ^1.1.0
- [functional-promises](https://npm.io/package/functional-promises.md) ^2.0.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 5.2.11 (latest) — 2023-04-05
- 5.2.10 — 2023-04-05
- 5.2.9 — 2023-04-05
- 5.1.9 — 2023-04-03
- 5.1.8 — 2023-04-03
- 5.0.6 — 2023-04-02
- 5.0.5 — 2023-04-02
- 5.0.4 — 2023-04-02
- 5.0.3 — 2023-04-02
- 5.0.0 — 2023-04-02
- 4.4.4 — 2023-04-01
- 4.0.3 — 2023-03-30
- 4.0.2 — 2023-03-30
- 3.6.6 — 2023-03-24
- 3.5.5 — 2023-03-24
- … 33 more at https://npm.io/package/gitbuddy/versions

## README

# GitBuddy - Your Git Best Friend

GitBuddy is an interactive CLI that provides simple prompts for common git commands. Prompts make it easy to stage a select groups of files, to help build good git habits, or break bad ones. Shorthand options allow you to easily skip through steps. And it returns clean, semantic responses throughout the process.

## Installation

**To get started, run:**

```bash
npm install -g gitbuddy
```

## Commands

**For the full prompt process:**

```bash
gitbuddy
```

## NEW! - Easy Branch Management

## Staging, Committing and Pushing Your Changes

> Step 1/3: Lists all available modified and untracked files to select from. Select one or multiple.

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_Step_1-min.gif)

> Step 2/3: Simply type your commit message.

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_Step_2-min.gif)

> Step 3/3: Confirm whether you want to push your changes to your remote repository or not. GitBuddy even identifies and pushes upstream if your branch doesn't exist in the remote repository yet!

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_Step_3-min.gif)

## Options/Flags

### Add All Flag

**To stage all files (and skip to the commit message prompt), use the `-a` or `-A` flag:**

```bash
gitbuddy -a
```

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_Add_Flag-min.gif)

### Auto Push Flag

**To push to your remote repository by default (skipping the last prompt), use the `-p` flag:**

```bash
gitbuddy -p
```

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_P_Flag-min.gif)

### Commit Message Option

**To add your commit message (and skip the commit message prompt):**

```bash
gitbuddy "Your commit message"
```

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_Commit_Flag-min.gif)

### Mix-and-Match Flags/Options

**Mix and match flags/options to initiate only the prompt(s) you want:**

i.e. Add your commit message and -p, and you will only be prompted to select files to stage. GitBuddy does the rest

```bash
gitbuddy -p "Your commit message"
```

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_Combo_Flags-min.gif)

### All-in-One Command

**Chain all the options together (in no particular order) to add, commit, and push, all in just one command:**

```bash
gitbuddy -a -p "Your commit message"
```

![](https://gitbuddy.s3-us-west-2.amazonaws.com/GitBuddy_All_Flags-min.gif)

---
_Source: https://npm.io/package/gitbuddy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._