gstat Command Documentation

commands/docs/gstat.md

7c9001912137bc7ea09800a766aa37da9af58cf4599b2ba50000000300000340

---
title: gstat
categories: |
  prompt
version: 0.104.0
prompt: |
  Get the git status of a repo
usage: |
  Get the git status of a repo
editLink: false
contributors: false
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# `gstat` for [prompt](/commands/categories/prompt.md)

<div class='command-title'>Get the git status of a repo</div>

::: warning This command requires a plugin
The `gstat` command resides in the `gstat` plugin.
To use this command, you must install and register `nu_plugin_gstat`.
See the [Plugins](/book/plugins.html) chapter in the book for more information.
:::


## Signature

```> gstat {flags} (path)```

## Parameters

 -  `path`: path to repo


## Input/output types:

| input | output |
| ----- | ------ |
| any   | any    |

Chunks

e5f08c1e (1st chunk of `commands/docs/gstat.md`)

Title: gstat Command Documentation

Summary

This document describes the `gstat` command, which retrieves the Git status of a repository. The command is part of the `gstat` plugin and requires the `nu_plugin_gstat` plugin to be installed and registered. It takes an optional path to the repository as input.