ging

https://www.npmjs.com/package/@vathsavv56/ging

ging is a Bun-powered terminal GitHub profile explorer built with Ink, React, and TypeScript.

It runs as a local CLI command, lets you search for a GitHub username, fetches profile data from the GitHub API, and renders a styled profile card directly in your terminal.

Install

Prerequisite: Bun must be installed on your system.

npm i -g @vathsavv56/ging

Or with Bun:

bun add -g @vathsavv56/ging

Then run:

ging

Features

• Interactive terminal UI built with Ink
• Live GitHub user lookup through the public GitHub users API
• Profile card showing login, name, bio, repo count, followers, following, company, and location
• Runtime-fetched GitHub Octocat mark rendered as ANSI art in the terminal
• Loading, error, and escape-to-exit states
• Local CLI command support through ging

Tech Stack

• Runtime: Bun
• UI: Ink + React
• Components: @inkjs/ui
• SVG rasterizing: @resvg/resvg-js
• ANSI image generation: jimp
• Language: TypeScript

Project Structure

.
|- index.tsx          # CLI entry point
|- src/
|  |- ui/
|     |- App.tsx      # Main terminal UI and GitHub fetch logic
|- package.json
|- README.md
|- tsconfig.json

Getting Started

1. Install dependencies

bun install

2. Link the CLI locally

bun link

This registers ging as a command in your local Bun environment.

3. Run the CLI

ging

If the command is not found immediately, restart the shell and run ging again.

4. Run in development mode

bun run dev

This starts the app in watch mode while you are changing the code.

How to Use

1. Start the app with ging, or use bun run dev during development.
2. Type a GitHub username (example: octocat) and press Enter.
3. Wait for the app to fetch GitHub user data and the Octocat SVG.
4. View the profile card in the terminal.
5. Press Esc anytime to quit.

Notes

• GitHub unauthenticated API requests are rate-limited (typically 60 requests/hour).
• If you hit the limit, the app shows a rate-limit error.
• The avatar artwork is fetched at runtime from GitHub's asset host as SVG and converted into terminal ANSI output.
• The displayed avatar is decorative and is not the searched user's actual GitHub avatar.

Troubleshooting

• ging command not found: Run bun link again, then restart your terminal session.
• Avatar looks wrong or does not render: Use a terminal with ANSI truecolor support.
• GitHub user not found: Check the username spelling.
• API errors or empty results: Verify your internet connection and confirm GitHub is reachable.
• Rate limit reached: Wait for the GitHub public API limit window to reset.

Scripts

• bun run dev - Run app in watch mode
• bun run start - Run the CLI entry directly once

License

MIT — see LICENSE for details.