gdir

0.2.5 • Public • Published

Git Dir

A command line tool to list git directories with their current branches or statuses.

Installation

gdir can be installed as a global command using npm and github.

NPM

$ npm install -g gdir

Github

$ npm install -g nishanbajracharya/gdir

Usage

The basic usage of gdir is to run the supplied command in a terminal session.

$ gdir

This will list down all the directories with git repos in the current path and the current git branch of each repo.

Options

gdir comes with a few options that can be used to filter branches or show statuses instead

Path

Path of directory to check repos in.

Option: -p, --path

Default: . Represents current directory

$ gdir --path path/to/directory
$ gdir -p ~/github

Path

Branch

Git branch to filter.

Option: -b, --branch

Default: Represents current branch

$ gdir --branch DEV-123

Shows any directory that are checked into DEV-123 branch.

$ gdir --branch DEV-

Shows any directory that match the DEV- string like DEV-, DEV-1, etc.

$ gdir -b dev

Shows any directory that match dev branch name.

Path

Type

Show current branch or status

Option: -t, --type Choices: branch, status

Default: branch

$ gdir --type branch

Shows list of directories and their corresponding current branches

$ gdir -t status

Shows list of directories and their current branch statuses

Path

Note: All options can be used in combination
$ gdir --path ~/github --branch dev --type status

Contributing

To contribute, follow one of the two options:

  • Open an Issue

    Open an issue detailing:

    1. What the issue is
    2. Steps to reproduce
    3. Possible solutions

    Note: These details are recommended but are entirely optional.

  • Send a Pull Request

    Fork this project and send a pull request to the main branch.

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i gdir

Weekly Downloads

1

Version

0.2.5

License

MIT

Unpacked Size

198 kB

Total Files

15

Last publish

Collaborators

  • nisbaj