git-aurafarm

A beautiful terminal interface for your GitHub statistics.

Features

• Responsive Design: The contribution calendar automatically scales to fit your terminal window.
• Interactive: Stays open as a dashboard (press q to quit).
• Git Stats: Fetches repositories, followers, and contribution graph.
• Zero Config: Uses your existing gh CLI authentication.

Prerequisites

• Node.js (v14+)
• Authentication (choose one):
  • GitHub CLI (gh) installed and authenticated (gh auth login)
  • OR set GITHUB_TOKEN environment variable

Usage

Global Install

npm install -g git-aurafarm
git-aurafarm

NPX (no install required)

npx git-aurafarm

Run Locally

1. Clone the repo:

   git clone <repo-url>
   cd git-aurafarm

2. Install dependencies:

   npm install

3. Build:

   npm run build

4. Run:

   npm start
   # OR
   node dist/cli.js

Options

• --mock: Use mock data (useful for testing UI without API limits or auth).

npm start -- --mock

Development

This project uses:

• Ink for the React-based TUI.
• Execa to call gh CLI.

To build for production/npx:

npm run build

Name origin: Was watching too many Minecraft videos and couldn't come up with a good name 💀 Reference