git-status-cli

git-status-cli

---

Get the output of 'git status' from the command line, formatted as JSON or plain text.

Available for macOS, Windows and Linux.

---

Contents

1. Installation
2. Usage
3. Examples
4. Platform Support
5. Contribute
6. Author

Installation

Installation as global NPM package

$ npm install --global git-status-cli

Usage

$ git-status [--format <output-format>] [--cwd <path>] [--git <path>]

• Parameters
  • -f, --format output-format - Output format (Options: json, text)
  • -c, --cwd path - Path to Git repository (Example: /home/user/myrepository)
  • -g, --git path - Path to Git executable (Example: /usr/bin/git)

Examples

Standard usage

$ git-status
>> {
>>     "modified": [ "README.md", "lib/index.js" ],
>>     "added": [ "LICENSE" ]
>> }  

Custom format

$ git-status-cli --format text
>> modified:		README.md, file2
>> added:		file3, file4

Custom repository path

$ git-status-cli --cwd "/Users/joeqpublic/Documents/myrepository"
>> modified:		README.md, file2
>> added:		file3, file4

Show Help

$ git-status-cli --help

Show Version

$ git-status-cli --version

Platform Support

Tested on:

• macOS Mojave (10.14.6)
• Windows 10 Spring Creators Update
• Ubuntu (18.04)

Contribute

Read the contribution documentation first.

• Dev Chat: Talk about features and suggestions.
• Issues File bugs and document issues.

Author

sidneys 2018