Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jwu910/check-it-out

A command line interface for Git Checkout. See branches available for checkout.
https://github.com/jwu910/check-it-out

check-it-out check-out checkout cli cli-tool command-line command-line-interface command-line-tool developer-tools devtool devtools git git-branch git-cli github-cli javascript js nodejs productivity

Last synced: 4 days ago
JSON representation

A command line interface for Git Checkout. See branches available for checkout.

Host: GitHub
URL: https://github.com/jwu910/check-it-out
Owner: jwu910
License: mit
Created: 2018-02-06T23:55:44.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-01-27T15:46:18.000Z (9 months ago)
Last Synced: 2024-07-22T02:06:03.075Z (4 months ago)
Topics: check-it-out, check-out, checkout, cli, cli-tool, command-line, command-line-interface, command-line-tool, developer-tools, devtool, devtools, git, git-branch, git-cli, github-cli, javascript, js, nodejs, productivity
Language: TypeScript
Homepage: https://jwu910.github.io/check-it-out/
Size: 8.72 MB
Stars: 154
Watchers: 5
Forks: 72
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-for-beginners - Check It Out - like CLI to let the user interactively navigate and select a git branch to check out. (JavaScript)
fucking-awesome-for-beginners - Check It Out - like CLI to let the user interactively navigate and select a git branch to check out. (JavaScript)

README

        


	

		

	





	

		

	

	

		

	

	

		

	

	

		

	

	

		

	

	

		

	

	

		

	

	

		

	

	

		

	





	

		

	







Check it out, before you checkout.

Check It Out lets you interactively see and choose what branch you want to check out without the hassle of trying to type out a long or confusing branch name. Checking out branches just got even simpler!

- [Requirements](#requirements)

- [Compatibility](#compatibility)

- [Installation](#installation)

  - [Installing from source](#installing-from-source)

- [Local development](#local-development)

- [Usage](#usage)

- [Features](#features)

- [Settings](#settings)

- [Contributing](#contributing)

- [Contributors](#contributors)

  - [Acknowledgements](#acknowledgements)

  - [License](#license)

## Requirements

[Node >= v16](https://nodejs.org/en/blog/release/v16.20.1) - _note:_ developed and tested on Node 16 and up. There isn't a guarantee this will work on earlier versions.

[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - Required for core features

## Compatibility

Check It Out currently has known issues with Windows. Some users have reported it working while others have reported that it does not. It is built and tested mostly in an Arch Linux environment with some user testing on MacOS and other Linux distributions. We're currently looking for help figuring out why Check It Out is unstable on Windows. See [CIO-128](https://github.com/jwu910/check-it-out/issues/128)

## Installation

We're on [NPM!](https://www.npmjs.org/package/check-it-out)

```

npm install -g check-it-out

```

### Installing from source

[Fork](https://github.com/jwu910/check-it-out#fork-destination-box) or clone the repository

```

git clone https://github.com/jwu910/check-it-out.git

```

Navigate to your repository directory and run

```

npm install

```

Create a symbolic link to the entry point

In the repository directory run:

```

npm link

```

## Local development

From your repository directory run

```

npm run build

```

To start the application you can run

```

node dist/index.js

```

or

```

npm start

```

If you want to test your local build in other repositories, you can use `npm link` which will let you run your local build files with the `cio` or `checkit` aliases.

## Usage

To get started, just run:

```

checkit

```

or

```

cio

```

![Check It Out Usage](docs/assets/images/checkit-usage.gif)

## Features

See a git log for the highlighted ref by pressing SPACE

![Quick Git Log!](docs/assets/images/checkit-log.gif)

| Commands                                                         | Description                                         |

| ---------------------------------------------------------------- | --------------------------------------------------- |

| j/k, ▼/▲ | Navigate the list                                   |

| h/l, ◄/► | Previous/Next remote                                |

| Ctrl+r                                     | Refresh list with a fetch and prune                 |

| enter                                                 | Select highlighted item                             |

| y                                                     | Copy highlighted item                               |

| space                                                 | Git log                                             |

| &                                                     | Filter lines - enter blank search to show all lines |

| /                                                     | Search Lines                                        |

| n                                                     | Jump to next search result                          |

| N                                                     | Jump to previous search result                      |

| q, Ctrl+c, esc       | Quit                                                |

## Settings

Git log argument validation is planned, but not finished. Currently, if the git log fails, space should not crash the app, but the process should not spawn at all.

Configurable settings can be found at `~/.config/configstore/check-it-out.json`

Options include:

- gitLogArguments

  - Type: Array

  - Default: `['--color=always', '--pretty=format:%C(yellow)%h %Creset%s%Cblue [%cn] %Cred%d ']`

  - Array of strings of valid git log arguments.

- sort

  - Type: String

  - Default: -committerdate

  - Sort references by latest commit date. Value must be a valid sort key or Check It Out will break on start.

- themeColor

  - Type: String

  - Default: `#FFA66D`

  - A hex color code to style Check It Out

To reset Check It Out to its original configurations listed above, start with the flag `--reset-config`:

```

cio --reset-config

```

## Contributing

Please refer to the [Contributing Guidelines](./CONTRIBUTING.md) before contributing.

See the rest of our [issues](https://github.com/jwu910/check-it-out/issues)

## Contributors

This project wouldn't have been possible with the help so many contributors both in and out of the source code. I look forward to working with you as this project continues to evolve and improve.

  

    

      
_{Brandon Benefield}
📖

      
_{Aaron Casanova}
💻

      
_{Drew Brokke}
💻 🤔 🚧

      
_{Johanna Tchon}
💻

      
_{Jenell Pizarro}
📖

      
_{Rebecca Hong}
🎨

      
_{Jesse Ma}
💻

    

    

      
_{Kien Do}
💬 🐛 🤔

      
_{Vu Tran}
💬 📖 🤔 📢

      
_{Efrain 'Rain' Rivas}
💬 🐛 💡 🚇 💻 📖

      
_{Phuc Le}
💬 📢

      
_{Can Cellek}
💻 📖

      
_{Aras Atasaygin}
🎨

      
_{Donald Lika}
💻

    

    

      
_{Connor Markwell}
💻

      
_ahlaw
💻

      
_{Kwadwo Busumtwi}
📖

      
_{Dev Kant K Chouhan}
📖

      
_{Jaya Krishna Namburu}
💻

      
_{Céleste Robinson}
📖

      
_{Juliardi عبدالله}
💻

    

    

      
_{Omar Roa}
📖

      
_Rachana
💻

      
_aksappy
🐛

      
_{Mahendra Kumar}
💻 📖

      
_{Anthony Camarillo}
💻 👀 🚧

      
_{TheCoolBlackCat}
💻 📖

      
_{Jimmy Vu}
📖

    

    

      
_{Catherine Njenga}
📖

      
_{Himanshu Chauhan}
🐛

    

  

### Acknowledgements

[@drewbrokke](https://github.com/drewbrokke) was the initial spark that inspired the creation of this project and encouraged me to let me curiosity drive this forward.

[@kiend](https://github.com/kiend) gave me the inspiration and motivation to finish this project after letting it sit for so long. [Check This Out](https://github.com/kiend/check-this-out). Thank you both for the encouragement and support through my career.

Logo Design by [@arasatasaygin](https://github.com/arasatasaygin) [@openlogos](http://openlogos.org)

### License

MIT @ [Joshua Wu](https://www.npmjs.com/~jwu910)