https://github.com/sidneys/git-status-cli

Get the file status (`git status`) of the current Git repository from the commandline. Format the output as JSON or plaintext.
https://github.com/sidneys/git-status-cli

Last synced: about 2 months ago
JSON representation

Get the file status (`git status`) of the current Git repository from the commandline. Format the output as JSON or plaintext.

• Host: GitHub
• URL: https://github.com/sidneys/git-status-cli
• Owner: sidneys
• License: mit
• Created: 2018-05-26T10:25:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-07-08T02:17:18.000Z (over 2 years ago)
• Last Synced: 2024-10-31T19:39:39.390Z (about 2 months ago)
• Language: JavaScript
• Size: 343 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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](#installation)

1. [Usage](#usage)

1. [Examples](#examples)

1. [Platform Support](#platform-support)

1. [Contribute](#contribute)

1. [Author](#author)

##  Installation

### Installation as global NPM package

```bash

$ npm install --global git-status-cli

```

##  Usage

```bash

$ git-status [--format ] [--cwd ] [--git ]

```

- 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

```bash

$ git-status

>> {

>>     "modified": [ "README.md", "lib/index.js" ],

>>     "added": [ "LICENSE" ]

>> }  

```

### Custom format

```bash

$ git-status-cli --format text

>> modified:		README.md, file2

>> added:		file3, file4

```

### Custom repository path

```bash

$ git-status-cli --cwd "/Users/joeqpublic/Documents/myrepository"

>> modified:		README.md, file2

>> added:		file3, file4

```

### Show Help

```bash

$ git-status-cli --help

```

### Show Version

```bash

$ git-status-cli --version

```

##  Platform Support

Tested on:

- macOS Mojave (10.14.6)

- Windows 10 Spring Creators Update

- Ubuntu (18.04)

##  Contribute ![Contribute](https://img.shields.io/badge/contributions-wanted-red.svg?style=flat-square)

Read the [contribution documentation](https://github.com/sidneys/git-status-cli/blob/release/CONTRIBUTING.md) first.

- [Dev Chat](http://gitter.im/sidneys/git-status-cli): Talk about features and suggestions.

- [Issues](http;//github.com/sidneys/git-status-cli/issues) File bugs and document issues.

##  Author

[sidneys](http://sidneys.github.io) 2018