giterm 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8bb0366aa299a669ac0a598be355c7ac6a680c5779a0207b77ce08eb9f4ad201
+  data.tar.gz: 5fbfaf7ec2512b2001deed99cb708a8ae5a00d4cb5fa00457f56cd193c1b53a0
+SHA512:
+  metadata.gz: f3586f793514e2405031582c40017cbf9e934a553d63331c98ac475068ebcef3b1fb490b34c016aca8f5a05ebf6b54ae70f0c587e489bc69b91a347489782fcb
+  data.tar.gz: bd9a1e651aa03c53e7289912c4f316c054b4d9e7953f953eb97f12f41ed75022470335e276d854d85109311b98fdefd255916be3bf139283f2f36696fb8897c3

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

data/README.md

@@ -0,0 +1,175 @@
+# GiTerm - Git & GitHub Terminal User Interface
+
+![Ruby](https://img.shields.io/badge/language-Ruby-red) [![Gem Version](https://badge.fury.io/rb/giterm.svg)](https://badge.fury.io/rb/giterm) ![License](https://img.shields.io/badge/license-Public_Domain-green)
+
+A powerful Git and GitHub Terminal User Interface (TUI) client written in Ruby using rcurses. Browse repositories, manage issues and pull requests, and perform Git operations - all from your terminal.
+
+## Key Features
+
+### 🔧 Git Operations
+- **Status View** (`s`) - View git status with colored file indicators
+- **Diff View** (`d`) - Show file diffs with syntax highlighting  
+- **Log View** (`l`) - Browse commit history with details
+- **Branch Management** (`b`) - List, switch, and manage branches
+- **Stage/Unstage** (`a`/`u`) - Stage or unstage files
+- **Commit** (`c`) - Commit changes with message editor
+- **Push/Pull** (`p`/`P`) - Sync with remote repositories
+- **Repository Switching** (`:cd`) - Change to different git repositories
+
+### 🌐 GitHub Integration  
+- **Repository Browser** (`TAB`) - Browse all your GitHub repositories with:
+  - Color-coded organizations for visual distinction
+  - Star/fork/issue counts
+  - Language indicators
+  - README preview with delayed fetching
+  - File tree exploration
+- **Issues** (`i`) - View repository issues
+- **Pull Requests** (`p` in GitHub mode) - View pull requests
+- **Search** (`/`) - Search across repositories
+- Automatic repository detection from git remote
+
+### 🎯 Enhanced Navigation
+- **List Navigation**
+  - `j`/`k` or `↓`/`↑` - Move up/down
+  - `PgUp`/`PgDn` - Page up/down
+  - `g`/`G` or `HOME`/`END` - Jump to top/bottom
+  - Smooth wrapping at list boundaries
+
+- **Right Pane Scrolling**
+  - `Shift-↓`/`Shift-↑` - Line down/up
+  - `Shift-→`/`Shift-←` - Page down/up
+  
+- **General**
+  - `TAB` - Toggle between Git/GitHub modes
+  - `h`/`←` - Go back/up one level
+  - `l`/`→` or `ENTER` - Enter/view details
+  - `?` - Show context-sensitive help
+  - `r` - Refresh current view
+  - `q` - Quit
+
+### Command Mode
+- `:` - Enter git command mode
+- `!` - Enter shell command mode
+
+## Requirements
+
+- Ruby 2.7 or higher
+- rcurses gem (will be installed automatically)
+- Git installed and configured
+- GitHub personal access token (for GitHub features)
+
+## Installation
+
+### Via RubyGems (Recommended)
+```bash
+gem install giterm
+```
+
+### Manual Installation
+```bash
+# Clone the repository
+git clone https://github.com/isene/GiTerm.git
+cd GiTerm
+
+# Make executable
+chmod +x giterm
+
+# Install dependencies
+gem install rcurses
+```
+
+## Usage
+
+Run GiTerm from within any Git repository:
+
+```bash
+giterm
+```
+
+Or if installed manually:
+```bash
+./giterm
+```
+
+### Interface Layout
+
+The interface consists of four panes:
+- **Top Pane**: Current repository, branch, and mode indicator
+- **Left Pane**: List view (files, branches, repos, etc.)
+- **Right Pane**: Detail view with scrollable content
+- **Bottom Pane**: Command input and status messages
+
+### Performance Features
+- **Smart Fetching**: Extended content (README, file lists) fetches after 0.5s pause
+- **Efficient Updates**: Only changed content is redrawn
+- **Mode Memory**: Remembers your position when switching between modes
+
+## Configuration
+
+### GitHub Token Setup
+
+To enable GitHub features, set up a personal access token:
+
+1. Create a token at: https://github.com/settings/tokens
+2. Required scopes: `repo`, `read:user`
+3. Set the environment variable:
+
+```bash
+# Add to your shell profile (.bashrc, .zshrc, etc.)
+export GITHUB_TOKEN=ghp_your_token_here
+```
+
+### Custom Configuration
+
+GiTerm looks for configuration in the following order:
+1. Environment variable `GITHUB_TOKEN`
+2. Git config: `git config --global giterm.token YOUR_TOKEN`
+
+### Additional Commands
+
+**Command Mode** (`:`):
+- `:cd /path/to/repo` - Change to a different git repository
+- Any git command - Executes in current repository
+
+**Shell Mode** (`!`):
+- Execute any shell command from within GiTerm
+
+## What's New
+
+### Version 1.0.0
+- 🎨 Organization color coding in GitHub mode
+- 📜 Right pane scrolling with Shift+Arrow keys
+- ⚡ Smart delayed fetching for smooth navigation
+- 🔄 Mode-specific index memory
+- 📁 Repository switching with `:cd` command
+- 🐛 Fixed display issues and improved performance
+
+## Design Philosophy
+
+GiTerm follows these principles:
+- **Single file implementation** - Easy to understand and modify
+- **Minimal dependencies** - Only requires rcurses
+- **Fast and responsive** - Optimized rendering and smart fetching
+- **Keyboard-driven** - No mouse required
+- **Clean Ruby code** - RuboCop compliant and well-documented
+
+## Contributing
+
+Contributions are welcome! Please:
+1. Fork the repository
+2. Create your feature branch
+3. Run RuboCop to ensure code style
+4. Submit a pull request
+
+## Author
+
+Created by Geir Isene ([@isene](https://github.com/isene))
+
+## License
+
+Public Domain - Use freely for any purpose.
+
+## See Also
+
+- [RTFM](https://github.com/isene/RTFM) - Ruby Terminal File Manager
+- [rcurses](https://github.com/isene/rcurses) - Ruby curses library used by GiTerm