https://github.com/xscriptor/gitnapse

Explore Git from a new perspective, through a different lens, in your terminal.
https://github.com/xscriptor/gitnapse

github github-api github-config github-developer github-developer-program gitnapse xscriptor

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/xscriptor/gitnapse
• Owner: xscriptor
• License: mit
• Created: 2026-04-23T20:28:40.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2026-06-15T12:59:02.000Z (7 days ago)
• Last Synced: 2026-06-15T14:25:55.452Z (7 days ago)
• Topics: github, github-api, github-config, github-developer, github-developer-program, gitnapse, xscriptor
• Language: Rust
• Homepage: https://dev.xscriptor.com
• Size: 215 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
GitNapse










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





    





Contents



  
Previews

  
Overview

  
Current Status

  
Quick Start

  
Remote Install / Uninstall

  
Release Automation

  
Documentation

  
X



Previews




  



More Previews...






  





  





  





  



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



  


OVERVIEW.md - complete feature list and capabilities

  


INSTALLATION.md - full install and uninstall by platform

  


REMOTE_INSTALLATION.md - remote scripts, parameters, and examples

  


USAGE.md - full command and in-app usage guide

  


OAUTH_AUTHENTICATION.md - OAuth login flows with octocrab and secure setup

  


THEME_CONFIG.md - theme file format and customization

  


COLLABORATIVE_SECTION.md - branch protection, PR workflow, and release publishing collaboration guide

  


RELEASE_WORKFLOW.md - release build/publish workflow and versioning commands

  


ARCHITECTURE.md - technical architecture details

  


IMPLEMENTATION_LOG.md - implementation materialization log

  


docs/tests/README.md - test and security audit documentation index

  


SECURITY.md - vulnerability reporting and response policy

  


CODE_OF_CONDUCT.md - expected behavior and community standards

  


CONTRIBUTING.md - contribution workflow and pull request guidelines





X










  



 & 



  



 &