# Git Status

Git status display (branch, staged, modified, ahead/behind)



<ComponentPreview base="ink" name="git-status-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/ink/git-status
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      npm install ink
      ```

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource src="registry/bases/ink/ui/types.ts" title="components/ui/types.ts" />

      <ComponentSource src="registry/bases/ink/themes/default.ts" title="lib/terminal-themes/default.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-theme.ts" title="hooks/use-theme.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-unicode.ts" title="hooks/use-unicode.ts" />

      <ComponentSource base="ink" name="git-status" title="components/ui/git-status.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { GitStatus } from "@/components/ui/git-status";
```

```tsx
<GitStatus branch="main" staged={2} modified={5} ahead={1} behind={0} />
```

API Reference [#api-reference]

GitStatus [#gitstatus]

| Prop       | Type     | Default    |
| ---------- | -------- | ---------- |
| `branch`   | `string` | `required` |
| `staged`   | `number` | `0`        |
| `modified` | `number` | `0`        |
| `ahead`    | `number` | `0`        |
| `behind`   | `number` | `0`        |

Notes [#notes]

Accessibility [#accessibility]

termcn exposes the following behavior through Ink's terminal accessibility APIs. This is not a browser ARIA or general WCAG-conformance claim.

* **Screen reader:** Ink labels and semantic state expose the component without relying on visual styling alone.