Skip to content

xscriptor/gitnapse

GitNapse

GitNapse Icon

Explore Git from a new perspective, through a different lens, in your terminal.

MIT License Rust 1.84+ GitHub Release CI Platform

Contents

Previews

GitNapse Preview 00
More Previews...
GitNapse Preview 01
GitNapse Preview 02
GitNapse Preview 03
GitNapse Preview 04

Overview

GitNapse is a Rust-first terminal application for exploring GitHub repositories from the command line. It provides repository discovery, branch-aware tree navigation, file previews, syntax-aware highlighting, clone workflows, and single-file download capabilities.

Current Status

  • Rust TUI stack based on ratatui + crossterm.
  • GitHub API integration for search, branches, tree, file content, and auth-user validation.
  • Token authentication through GITHUB_TOKEN or secure local storage.
  • Repository tree exploration with lazy loading and branch switching.
  • Preview pane with focus support, keyboard/mouse scroll, and syntax-aware display.
  • In-app file download modal and CLI file download command.

Quick Start

gitnapse
gitnapse run --query "xscriptor" --page 1 --per-page 30 --cache-ttl-secs 900
gitnapse auth set
gitnapse auth oauth login --client-id YOUR_OAUTH_CLIENT_ID --scope read:user --scope repo

Remote Install / Uninstall

Linux / macOS (curl):

curl -fsSL https://raw.githubusercontent.com/xscriptor/gitnapse/main/scripts/install.sh | bash -s -- --action install
curl -fsSL https://raw.githubusercontent.com/xscriptor/gitnapse/main/scripts/install.sh | bash -s -- --action uninstall --cleanup

Linux / macOS (wget):

wget -qO- https://raw.githubusercontent.com/xscriptor/gitnapse/main/scripts/install.sh | bash -s -- --action install
wget -qO- https://raw.githubusercontent.com/xscriptor/gitnapse/main/scripts/install.sh | bash -s -- --action uninstall --cleanup

Windows 11 PowerShell:

irm https://raw.githubusercontent.com/xscriptor/gitnapse/main/scripts/install.ps1 | iex
& ([scriptblock]::Create((irm https://raw.githubusercontent.com/xscriptor/gitnapse/main/scripts/install.ps1))) -Action uninstall -Cleanup

Release Automation

GitHub Actions release pipeline is available in .github/workflows/release.yml. Push a version tag like v1.0.0 to build Windows, Linux (Ubuntu/Arch/Fedora), and macOS assets and publish them in GitHub Releases.

Documentation

X

X Web & X Github Profile & Xscriptor web

About

Explore Git from a new perspective, through a different lens, in your terminal.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors