https://github.com/snwfdhmp/git-ls

list local git repos and their status
https://github.com/snwfdhmp/git-ls

git git-ls ls repository-management repository-manager

Last synced: about 2 months ago
JSON representation

list local git repos and their status

• Host: GitHub
• URL: https://github.com/snwfdhmp/git-ls
• Owner: snwfdhmp
• Created: 2024-11-08T16:13:00.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-02-09T14:10:43.000Z (over 1 year ago)
• Last Synced: 2025-02-26T09:08:28.426Z (over 1 year ago)
• Topics: git, git-ls, ls, repository-management, repository-manager
• Language: JavaScript
• Homepage:
• Size: 69.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# git-ls: list local git repos and their status

## Basic usage

![git-ls demo](https://i.imgur.com/O3ch0xq.png)

## More options

![git-ls demo2](https://i.imgur.com/Mu4yG5b.png)

## Install

**🔹 Requires node.** [How to install node](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Tested on Node v18+ (might work for earlier versions)

```

$ git clone git@github.com:snwfdhmp/git-ls.git

# or

$ git clone https://github.com/snwfdhmp/git-ls.git

```

then

```

cd git-ls

npm i

chmod u+x git-ls

git config --global alias.ls "\!$(pwd)/git-ls"

```

you can now do

```

$ git ls

```

update for latest features with

```

$ git ls --update

```

## Usage

```

usage: git ls [options] [/path/to/parent1] [/path/to/parent2] [...]

options:

  -h, --help      Show this help message and exit

  -o, --only-git  Only show git repositories

  -s, --short     Use ⇣⇡↕!+? symbols for status

  -i, --ignore    Only repo with status flags

  -q, --quiet     Do not show progress

  --update        Upgrade git-ls with latest version

  --upgrade       Alias for --update

```

## FAQ

### Status meaning

| status | meaning                                                           |

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

| pull   | New commits available on remote for this branch                   |

| push   | You have commits to push (ahead from remote)                      |

| add    | You have changes to add (on tracked files)                        |

| commit | You have staging changes (you git-added something without commit) |

| track  | You have untracked files (need to git-add or git-ignore)          |

### How to watch all my local parent folders ?

Create an alias

```

$ alias watch_my_git_parent="git ls -o /home/mygit /another/path /yet/another"

$ watch_my_git

```

Put the alias command in your .profile

## Using it in production

Since the project is relatively new, the API is not stable yet. Use it in scripts at your own risk.

If you plan on using this in script, open an issue and i'll provide a stable and grep-able API.

# Contributing

⭐️ Leaving a star helps a lot !

📭 PR/Issues are open. Send your PR or your feature request